ru.j1c
Class DocumentObject

java.lang.Object
  extended by ru.j1c.Obj
      extended by ru.j1c.DocumentObject
All Implemented Interfaces:
Serializable, Document

public class DocumentObject
extends Obj
implements Document

Класс предствляет документ-объект системы.
Использется, для изменения даных в системе.

Author:
max
See Also:
Serialized Form

Method Summary
 void cancelClose()
          Отменить проведение документа
 void cancelDelete()
          Снять отметку удаления с документа
 void close()
           
 void delete(boolean value)
          Удалить документ.
 AccountingRecordSet getAccountRecordSet()
          Получить коллекцию движений по бухгалтерии
<T> T
getAttribute(String name)
          Получить атрибут объекта
 Map<String,Object> getAttributes()
           
 Date getDate()
          Получить дату документа
 Detail getDetail()
          Получить табличную часть документа
 String getNumber()
          Получить номер документа
 OperationReference getOperation()
          Получить операцию документа
 Position getPosition()
          Получить позицию документа
 RegisterRecordSet getRegisterRecordSet(String name)
          Получить коллекцию движений по регистру
 boolean isClosed()
          Получить признак провеения документа
 boolean isCreateOperation()
          Для конкретного вида документа (имеющего признак ''Бухгалтерский учет'') возможны режимы записи операции: ''Всегда'', ''Выборочно'' и ''Только при проведении''.
 boolean isMark()
           
 boolean isNew()
          Определить факт существования объекта в системе.
 void newObject()
          Создать новый объект ссылочного типа
 void setAttribute(String name, Object value)
          Установить значение атрибута объекта
 void setCreateOperation(boolean createOperation)
          Для конкретного вида документа (имеющего признак ''Бухгалтерский учет'') возможны режимы записи операции: ''Всегда'', ''Выборочно'' и ''Только при проведении''.
 void setDate(Date date)
          Установить дату документа
 void setNumber(String number)
          Установить номер документа
 void setRef(Ref ref)
          Спозиционировать объект на ссылку этого же типа.
 void setRow(int row)
          Записывать номер строки документа в движениях документа.
 String toString()
           
 void write()
           
 
Methods inherited from class ru.j1c.Obj
getMetaObject, getRef
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

setDate

public void setDate(Date date)
Установить дату документа

Parameters:
date - Дата документа

setNumber

public void setNumber(String number)
Установить номер документа

Parameters:
number - Номер документа

setRow

public void setRow(int row)
Записывать номер строки документа в движениях документа. Метод устанавливает номер строки для всех последующих движений регистров, при записи значений периодических реквизитов справочников с привязкой к документу, а также при записи бухгалтерских проводок.

Parameters:
row - Номе строки документа

setCreateOperation

public void setCreateOperation(boolean createOperation)
Для конкретного вида документа (имеющего признак ''Бухгалтерский учет'') возможны режимы записи операции: ''Всегда'', ''Выборочно'' и ''Только при проведении''.
Метод применяется только в случае использования режима ''Выборочно''. Для режимов записи операции ''Всегда'' и ''Только при проведении'' данный метод смысла не имеет. Он устанавливает признак наличия операции у конкретного документа. Данная возможность позволяет записывать операцию для документов конкретного вида в зависимости от некоторых условий.

Parameters:
createOperation - the createOperation to set

isCreateOperation

public boolean isCreateOperation()
Для конкретного вида документа (имеющего признак ''Бухгалтерский учет'') возможны режимы записи операции: ''Всегда'', ''Выборочно'' и ''Только при проведении''.
Метод применяется только в случае использования режима ''Выборочно''. Для режимов записи операции ''Всегда'' и ''Только при проведении'' данный метод смысла не имеет. Он устанавливает признак наличия операции у конкретного документа. Данная возможность позволяет записывать операцию для документов конкретного вида в зависимости от некоторых условий.

Returns:
the createOperation

setRef

public void setRef(Ref ref)
Description copied from class: Obj
Спозиционировать объект на ссылку этого же типа.

Overrides:
setRef in class Obj

newObject

public void newObject()
Description copied from class: Obj
Создать новый объект ссылочного типа

Specified by:
newObject in class Obj

close

public void close()

cancelClose

public void cancelClose()
Отменить проведение документа


write

public void write()

setAttribute

public void setAttribute(String name,
                         Object value)
Description copied from class: Obj
Установить значение атрибута объекта

Specified by:
setAttribute in class Obj
Parameters:
name - Имя атрибута, как задан в конфигурации
value - Значение атрибута

getDetail

public Detail getDetail()
Description copied from interface: Document
Получить табличную часть документа

Specified by:
getDetail in interface Document
Returns:
Табличная часть документа

getAttributes

public Map<String,Object> getAttributes()

getAttribute

public <T> T getAttribute(String name)
Description copied from class: Obj
Получить атрибут объекта

Specified by:
getAttribute in class Obj
Parameters:
name - Имя реквизита
Returns:
Значение реквизита

isMark

public boolean isMark()
Specified by:
isMark in interface Document

getDate

public Date getDate()
Description copied from interface: Document
Получить дату документа

Specified by:
getDate in interface Document
Returns:
Дата Документа

getAccountRecordSet

public AccountingRecordSet getAccountRecordSet()
Получить коллекцию движений по бухгалтерии

Returns:
Коллекция движений.

getRegisterRecordSet

public RegisterRecordSet getRegisterRecordSet(String name)
Получить коллекцию движений по регистру

Parameters:
name - Имя регистра, как задан в метаданных
Returns:
Коллекция движений

getNumber

public String getNumber()
Description copied from interface: Document
Получить номер документа

Specified by:
getNumber in interface Document
Returns:
Номер документа

toString

public String toString()
Overrides:
toString in class Object

getPosition

public Position getPosition()
Description copied from interface: Document
Получить позицию документа

Specified by:
getPosition in interface Document
Returns:
Позиция документа в формате date_time_iddoc

getOperation

public OperationReference getOperation()
Получить операцию документа

Returns:
the operation Операция документа.

delete

public void delete(boolean value)
Удалить документ.

Parameters:
value - Режим удаления. true - удалить полностью, false - пометить на удаление

cancelDelete

public void cancelDelete()
Снять отметку удаления с документа


isClosed

public boolean isClosed()
Description copied from interface: Document
Получить признак провеения документа

Specified by:
isClosed in interface Document
Returns:
true - проведен, false - не проведен

isNew

public boolean isNew()
Description copied from class: Obj
Определить факт существования объекта в системе.

Specified by:
isNew in class Obj
Returns:
true - объект существует, false - объект еще не записан


Copyright © 2011 J1C corp. All Rights Reserved.