ru.j1c
Class DocumentReference

java.lang.Object
  extended by ru.j1c.Ref
      extended by ru.j1c.DocumentReference
All Implemented Interfaces:
Serializable, Document

public class DocumentReference
extends Ref
implements Document

Класс представляет документ-ссылку системы.

Author:
max
See Also:
Serialized Form

Method Summary
 AccountingRecordSet getAccountRecordSet()
          Получить коллекцию движений по бухгалтерии
<T> T
getAttribute(String name)
           
 Map<String,Object> getAttributes()
          Метод предоствляет коллекцию значений объекта ссылки.
 Date getDate()
          Получить дату документа
 Detail getDetail()
          Получить табличную часть документа
 String getNumber()
          Получить номер документа
 DocumentObject getObj()
           
 OperationReference getOperation()
          Доступ к бухгалтерской операции документа.
 Position getPosition()
          Получить позицию документа
 RegisterRecordSet getRegisterRecordSet(String name)
          Получить коллекцию движений по регистру
 BigDecimal getTotal(String name)
          Возвращает сумму значений реквизита по всем строкам табличной части документа.
 String getTSP()
          Получает значение внутреннего представления объекта, когда в метаданных назначен тип 'Неопределенный', которое необходимо записать в соответствующее поле TSPXXX
 boolean isClosed()
          Получить признак провеения документа
 boolean isMark()
           
 String toString()
           
 
Methods inherited from class ru.j1c.Ref
equals, fromInnerValue, getId, getMetaObject, hashCode, isNull, toInnerValue, toInnerValue
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

getDetail

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

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

getAttributes

public Map<String,Object> getAttributes()
Метод предоствляет коллекцию значений объекта ссылки. Рекомендуется используется тогда, когда клиент заинтересован в получении большого количества свойств объекта, в этом случае метод выбирает все свойства за один запрос.

Returns:
Коллекция пар имени и значения свойств.

getAttribute

public <T> T getAttribute(String name)

getTotal

public BigDecimal getTotal(String name)
Возвращает сумму значений реквизита по всем строкам табличной части документа.
Метод можно использовать только для реквизитов табличной части документов с установленным свойством 'Итог по колонке'.

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:
Дата Документа

getNumber

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

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

getOperation

public OperationReference getOperation()
Доступ к бухгалтерской операции документа. Атрибут имеет смысл только для тех видов документов, для которых в конфигурации установлен признак ''Бухгалтерский учет''. Данный атрибут не используется как самостоятельное значение, а позволяет обращаться к атрибутам и методам операции.

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

getAccountRecordSet

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

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

getRegisterRecordSet

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

Parameters:
name - Имя регистра, как задан в метаданных
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

getObj

public DocumentObject getObj()

isClosed

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

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

getTSP

public String getTSP()
Description copied from class: Ref
Получает значение внутреннего представления объекта, когда в метаданных назначен тип 'Неопределенный', которое необходимо записать в соответствующее поле TSPXXX

Returns:
Строка длиной 3 символа.


Copyright © 2011 J1C corp. All Rights Reserved.