org.opencrx.kernel.document1.cci
Class DocumentFolderImpl

java.lang.Object
  org.openmdx.base.accessor.jmi.spi.RefObject_1
      org.opencrx.kernel.document1.cci.DocumentFolderImpl

All Implemented Interfaces:

Serializable, PersistenceCapable, RefBaseObject, RefFeatured, RefObject, Auditee, Indexed, SecureObject, DocumentFolder, RefObject_1_0, BasicObject, ContextCapable, ExtentCapable, ViewCapable

public class DocumentFolderImpl
extends RefObject_1
implements DocumentFolder

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface javax.jdo.spi.PersistenceCapable

PersistenceCapable.ObjectIdFieldConsumer, PersistenceCapable.ObjectIdFieldManager, PersistenceCapable.ObjectIdFieldSupplier

Field Summary

Fields inherited from interface javax.jdo.spi.PersistenceCapable

CHECK_READ, CHECK_WRITE, LOAD_REQUIRED, MEDIATE_READ, MEDIATE_WRITE, READ_OK, READ_WRITE_OK, SERIALIZABLE

Constructor Summary

DocumentFolderImpl(Object_1_0 object, RefClass refClass)

Method Summary

protected void	addAudit(AuditEntry newValue)
protected void	addAudit(String id, AuditEntry newValue)
protected void	addContext(Context newValue)
protected void	addContext(String id, Context newValue)
protected void	addDocument(Document newValue)
protected void	addDocument(String id, Document newValue)
protected void	addFolder(DocumentFolder newValue)
protected void	addFolder(String id, DocumentFolder newValue)
protected void	addIndexEntry(IndexEntry newValue)
protected void	addIndexEntry(String id, IndexEntry newValue)
void	addOwningGroup(int index, PrincipalGroup newValue)
ModifySecureObjectResult	addOwningGroup(ModifyOwningGroupParams params)
void	addOwningGroup(PrincipalGroup newValue)
ModifySecureObjectResult	addOwningGroup(PrincipalGroup group, short mode)
protected void	addView(String namespace, View newValue)
protected void	addView(View newValue)
BasicObject	getAccessGrantedByParent() Retrieves the value for the optional reference accessGrantedByParent.
short	getAccessLevelBrowse() Retrieves the value for the attribute accessLevelBrowse.
protected short	getAccessLevelBrowse(int index)
short	getAccessLevelDelete() Retrieves the value for the attribute accessLevelDelete.
protected short	getAccessLevelDelete(int index)
short	getAccessLevelUpdate() Retrieves the value for the attribute accessLevelUpdate.
protected short	getAccessLevelUpdate(int index)
Collection	getAudit() Retrieves a collection containing all the elements for the reference audit.
List	getAudit(AuditEntryFilter filter) Retrieves the value for the reference audit for the specified filter.
List	getAudit(AuditEntryQuery query) Retrieves the value for the reference audit for the specified query.
AuditEntry	getAudit(String id) Retrieves the value for the reference audit for the specified qualifier attribute value.
Collection	getContext() Retrieves the objects referenced by context.
Context	getContext(String id) Retrieves the value for the reference context for the specified qualifier attribute value.
Date	getCreatedAt() Retrieves the value for the attribute createdAt.
protected Date	getCreatedAt(int index)
Set	getCreatedBy()
String	getDescription() Retrieves the value for the attribute description.
protected String	getDescription(int index)
Collection	getDocument() Retrieves a collection containing all the elements for the reference document.
List	getDocument(DocumentFilter filter) Retrieves the value for the reference document for the specified filter.
List	getDocument(DocumentQuery query) Retrieves the value for the reference document for the specified query.
Document	getDocument(String id) Retrieves the value for the reference document for the specified qualifier attribute value.
Collection	getFolder() Retrieves a collection containing all the elements for the reference folder.
List	getFolder(DocumentFolderFilter filter) Retrieves the value for the reference folder for the specified filter.
List	getFolder(DocumentFolderQuery query) Retrieves the value for the reference folder for the specified query.
DocumentFolder	getFolder(String id) Retrieves the value for the reference folder for the specified qualifier attribute value.
String	getIdentity() Retrieves the value for the attribute identity.
protected String	getIdentity(int index)
Collection	getIndexEntry() Retrieves a collection containing all the elements for the reference indexEntry.
List	getIndexEntry(IndexEntryFilter filter) Retrieves the value for the reference indexEntry for the specified filter.
List	getIndexEntry(IndexEntryQuery query) Retrieves the value for the reference indexEntry for the specified query.
IndexEntry	getIndexEntry(String id) Retrieves the value for the reference indexEntry for the specified qualifier attribute value.
Date	getModifiedAt() Retrieves the value for the attribute modifiedAt.
protected Date	getModifiedAt(int index)
Set	getModifiedBy()
String	getName() Retrieves the value for the attribute name.
protected String	getName(int index)
List	getOwner()
String	getOwner(int index)
Collection	getOwningGroup() Retrieves the objects referenced by owningGroup.
PrincipalGroup	getOwningGroup(int index) Retrieves the value for the reference owningGroup for the specified qualifier attribute value.
User	getOwningUser() Retrieves the value for the optional reference owningUser.
DocumentFolder	getParent() Retrieves the value for the optional reference parent.
Collection	getView() Retrieves a collection containing all the elements for the reference view.
View	getView(String namespace) Retrieves the value for the reference view for the specified qualifier attribute value.
List	getView(ViewFilter filter) Retrieves the value for the reference view for the specified filter.
List	getView(ViewQuery query) Retrieves the value for the reference view for the specified query.
protected void	removeAccessGrantedByParent()
ModifySecureObjectResult	removeAllOwningGroup(RemoveAllOwningGroupParams params)
ModifySecureObjectResult	removeAllOwningGroup(short mode)
protected void	removeAudit(String id)
protected void	removeContext(String id)
protected void	removeDocument(String id)
protected void	removeFolder(String id)
protected void	removeIndexEntry(String id)
void	removeOwningGroup(int index)
ModifySecureObjectResult	removeOwningGroup(ModifyOwningGroupParams params)
ModifySecureObjectResult	removeOwningGroup(PrincipalGroup group, short mode)
void	removeOwningUser() Removes the value for the optional reference owningUser.
void	removeParent() Removes the value for the optional reference parent.
protected void	removeView(String namespace)
protected void	setAccessGrantedByParent(BasicObject newValue)
ModifySecureObjectResult	setAccessLevel(SetAccessLevelParams params)
ModifySecureObjectResult	setAccessLevel(short accessLevelBrowse, short accessLevelDelete, short accessLevelUpdate, short mode)
protected void	setAccessLevelBrowse(int index, short newValue)
void	setAccessLevelBrowse(short newValue) Sets a new value for the attribute accessLevelBrowse.
protected void	setAccessLevelDelete(int index, short newValue)
void	setAccessLevelDelete(short newValue) Sets a new value for the attribute accessLevelDelete.
protected void	setAccessLevelUpdate(int index, short newValue)
void	setAccessLevelUpdate(short newValue) Sets a new value for the attribute accessLevelUpdate.
protected void	setAudit(AuditEntry[] newValue)
protected void	setAudit(List newValue)
protected void	setContext(Context[] newValue)
protected void	setContext(List newValue)
protected void	setCreatedAt(Date newValue)
protected void	setCreatedAt(int index, Date newValue)
protected void	setCreatedBy(Set newValue)
protected void	setCreatedBy(String[] newValue)
protected void	setDescription(int index, String newValue)
void	setDescription(String newValue) Sets a new value for the attribute description.
protected void	setDocument(Document[] newValue)
protected void	setDocument(List newValue)
protected void	setFolder(DocumentFolder[] newValue)
protected void	setFolder(List newValue)
protected void	setIdentity(int index, String newValue)
protected void	setIdentity(String newValue)
protected void	setIndexEntry(IndexEntry[] newValue)
protected void	setIndexEntry(List newValue)
protected void	setModifiedAt(Date newValue)
protected void	setModifiedAt(int index, Date newValue)
protected void	setModifiedBy(Set newValue)
protected void	setModifiedBy(String[] newValue)
protected void	setName(int index, String newValue)
void	setName(String newValue) Sets a new value for the attribute name.
protected void	setOwner(List newValue)
protected void	setOwner(String[] newValue)
void	setOwningGroup(List newValue)
void	setOwningGroup(PrincipalGroup[] newValue)
ModifySecureObjectResult	setOwningUser(SetOwningUserParams params)
ModifySecureObjectResult	setOwningUser(short mode, User user)
void	setOwningUser(User newValue) Sets a new value for the reference owningUser.
void	setParent(DocumentFolder newValue) Sets a new value for the reference parent.
protected void	setView(List newValue)
protected void	setView(View[] newValue)
Void	updateIndex()
Void	updateIndex(Void params)

Methods inherited from class org.openmdx.base.accessor.jmi.spi.RefObject_1

equals, jdoCopyFields, jdoCopyKeyFieldsFromObjectId, jdoCopyKeyFieldsToObjectId, jdoCopyKeyFieldsToObjectId, jdoGetObjectId, jdoGetPersistenceManager, jdoGetTransactionalObjectId, jdoGetVersion, jdoIsDeleted, jdoIsDetached, jdoIsDirty, jdoIsNew, jdoIsPersistent, jdoIsTransactional, jdoMakeDirty, jdoNewInstance, jdoNewInstance, jdoNewObjectIdInstance, jdoNewObjectIdInstance, jdoProvideField, jdoProvideFields, jdoReplaceField, jdoReplaceFields, jdoReplaceFlags, jdoReplaceStateManager, refAddEventListener, refAddToUnitOfWork, refAddValue, refAddValue, refAddValue, refClass, refContext, refDefaultFetchGroup, refDelegate, refDelete, refFlush, refGetEventListeners, refGetPath, refGetValue, refGetValue, refGetValue, refGetValue, refGetValue, refGetValue, refGetValue, refGetValue, refImmediateComposite, refImmediatePackage, refInitialize, refInitialize, refInvokeOperation, refInvokeOperation, refIsDeleted, refIsDirty, refIsInstanceOf, refIsNew, refIsPersistent, refIsWriteProtected, refMetaObject, refMofId, refOutermostComposite, refOutermostPackage, refRefresh, refRefreshAsynchronously, refRemoveEventListener, refRemoveFromUnitOfWork, refRemoveValue, refRemoveValue, refRemoveValue, refRemoveValue, refSetValue, refSetValue, refSetValue, refSetValue, refVerifyConstraints, refWriteProtect, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openmdx.base.accessor.jmi.cci.RefObject_1_0

refAddEventListener, refAddToUnitOfWork, refAddValue, refContext, refDefaultFetchGroup, refDelegate, refFlush, refGetEventListeners, refGetPath, refGetValue, refGetValue, refInitialize, refInitialize, refIsDeleted, refIsDirty, refIsNew, refIsPersistent, refIsWriteProtected, refRefresh, refRefreshAsynchronously, refRemoveEventListener, refRemoveFromUnitOfWork, refRemoveValue, refRemoveValue, refSetValue, refWriteProtect

Methods inherited from interface javax.jmi.reflect.RefObject

refClass, refDelete, refImmediateComposite, refIsInstanceOf, refOutermostComposite

Methods inherited from interface javax.jmi.reflect.RefFeatured

refGetValue, refGetValue, refInvokeOperation, refInvokeOperation, refSetValue, refSetValue

Methods inherited from interface javax.jmi.reflect.RefBaseObject

equals, hashCode, refImmediatePackage, refMetaObject, refMofId, refOutermostPackage, refVerifyConstraints

Constructor Detail

DocumentFolderImpl

public DocumentFolderImpl(Object_1_0 object,
                          RefClass refClass)

Method Detail

setAudit

protected void setAudit(List newValue)

setAudit

protected void setAudit(AuditEntry[] newValue)

getAudit

public AuditEntry getAudit(String id)

Description copied from interface: Auditee

Retrieves the value for the reference audit for the specified qualifier attribute value.

Specified by:

getAudit in interface Auditee

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

getAudit

public Collection getAudit()

Description copied from interface: Auditee

Retrieves a collection containing all the elements for the reference audit.

Specified by:

getAudit in interface Auditee

Returns:

A collection containing all the elements for this reference.

getAudit

public List getAudit(AuditEntryFilter filter)

Description copied from interface: Auditee

Retrieves the value for the reference audit for the specified filter.

Specified by:

getAudit in interface Auditee

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

getAudit

public List getAudit(AuditEntryQuery query)

Description copied from interface: Auditee

Retrieves the value for the reference audit for the specified query.

Specified by:

getAudit in interface Auditee

Returns:

The filtered collection of referenced objects.

addAudit

protected void addAudit(String id,
                        AuditEntry newValue)

addAudit

protected void addAudit(AuditEntry newValue)

removeAudit

protected void removeAudit(String id)

setIndexEntry

protected void setIndexEntry(List newValue)

setIndexEntry

protected void setIndexEntry(IndexEntry[] newValue)

getIndexEntry

public IndexEntry getIndexEntry(String id)

Description copied from interface: Indexed

Retrieves the value for the reference indexEntry for the specified qualifier attribute value.

Specified by:

getIndexEntry in interface Indexed

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

getIndexEntry

public Collection getIndexEntry()

Description copied from interface: Indexed

Retrieves a collection containing all the elements for the reference indexEntry.

Specified by:

getIndexEntry in interface Indexed

Returns:

A collection containing all the elements for this reference.

getIndexEntry

public List getIndexEntry(IndexEntryFilter filter)

Description copied from interface: Indexed

Retrieves the value for the reference indexEntry for the specified filter.

Specified by:

getIndexEntry in interface Indexed

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

getIndexEntry

public List getIndexEntry(IndexEntryQuery query)

Description copied from interface: Indexed

Retrieves the value for the reference indexEntry for the specified query.

Specified by:

getIndexEntry in interface Indexed

Returns:

The filtered collection of referenced objects.

addIndexEntry

protected void addIndexEntry(String id,
                             IndexEntry newValue)

addIndexEntry

protected void addIndexEntry(IndexEntry newValue)

removeIndexEntry

protected void removeIndexEntry(String id)

updateIndex

public Void updateIndex(Void params)
                 throws RefException

Specified by:

updateIndex in interface Indexed

Throws:

RefException

updateIndex

public Void updateIndex()
                 throws RefException

Specified by:

updateIndex in interface Indexed

Throws:

RefException

getAccessGrantedByParent

public BasicObject getAccessGrantedByParent()

Description copied from interface: SecureObject

Retrieves the value for the optional reference accessGrantedByParent.

Specified by:

getAccessGrantedByParent in interface SecureObject

Returns:

The possibly null value for this reference.

setAccessGrantedByParent

protected void setAccessGrantedByParent(BasicObject newValue)

removeAccessGrantedByParent

protected void removeAccessGrantedByParent()

getAccessLevelBrowse

public short getAccessLevelBrowse()

Description copied from interface: SecureObject

Retrieves the value for the attribute accessLevelBrowse.

Specified by:

getAccessLevelBrowse in interface SecureObject

Returns:

The non-null value for attribute accessLevelBrowse.

getAccessLevelBrowse

protected short getAccessLevelBrowse(int index)

setAccessLevelBrowse

public void setAccessLevelBrowse(short newValue)

Description copied from interface: SecureObject

Sets a new value for the attribute accessLevelBrowse.

Specified by:

setAccessLevelBrowse in interface SecureObject

Parameters:

newValue - The non-null new value for attribute accessLevelBrowse.

setAccessLevelBrowse

protected void setAccessLevelBrowse(int index,
                                    short newValue)

getAccessLevelDelete

public short getAccessLevelDelete()

Description copied from interface: SecureObject

Retrieves the value for the attribute accessLevelDelete.

Specified by:

getAccessLevelDelete in interface SecureObject

Returns:

The non-null value for attribute accessLevelDelete.

getAccessLevelDelete

protected short getAccessLevelDelete(int index)

setAccessLevelDelete

public void setAccessLevelDelete(short newValue)

Description copied from interface: SecureObject

Sets a new value for the attribute accessLevelDelete.

Specified by:

setAccessLevelDelete in interface SecureObject

Parameters:

newValue - The non-null new value for attribute accessLevelDelete.

setAccessLevelDelete

protected void setAccessLevelDelete(int index,
                                    short newValue)

getAccessLevelUpdate

public short getAccessLevelUpdate()

Description copied from interface: SecureObject

Retrieves the value for the attribute accessLevelUpdate.

Specified by:

getAccessLevelUpdate in interface SecureObject

Returns:

The non-null value for attribute accessLevelUpdate.

getAccessLevelUpdate

protected short getAccessLevelUpdate(int index)

setAccessLevelUpdate

public void setAccessLevelUpdate(short newValue)

Description copied from interface: SecureObject

Sets a new value for the attribute accessLevelUpdate.

Specified by:

setAccessLevelUpdate in interface SecureObject

Parameters:

newValue - The non-null new value for attribute accessLevelUpdate.

setAccessLevelUpdate

protected void setAccessLevelUpdate(int index,
                                    short newValue)

addOwningGroup

public ModifySecureObjectResult addOwningGroup(ModifyOwningGroupParams params)
                                        throws RefException

Specified by:

addOwningGroup in interface SecureObject

Throws:

RefException

addOwningGroup

public ModifySecureObjectResult addOwningGroup(PrincipalGroup group,
                                               short mode)
                                        throws RefException

Specified by:

addOwningGroup in interface SecureObject

Throws:

RefException

getOwner

public List getOwner()

Specified by:

getOwner in interface SecureObject

Returns:

A list containing all elements for this attribute.

getOwner

public String getOwner(int index)

Specified by:

getOwner in interface SecureObject

Parameters:

index - The index of the element to return.

Returns:

The element at the specified position in the list of all values for this attribute.

setOwner

protected void setOwner(List newValue)

setOwner

protected void setOwner(String[] newValue)

setOwningGroup

public void setOwningGroup(List newValue)

setOwningGroup

public void setOwningGroup(PrincipalGroup[] newValue)

getOwningGroup

public PrincipalGroup getOwningGroup(int index)

Description copied from interface: SecureObject

Retrieves the value for the reference owningGroup for the specified qualifier attribute value.

Specified by:

getOwningGroup in interface SecureObject

Parameters:

index - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

getOwningGroup

public Collection getOwningGroup()

Description copied from interface: SecureObject

Retrieves the objects referenced by owningGroup.

Specified by:

getOwningGroup in interface SecureObject

Returns:

The collection of referenced objects.

addOwningGroup

public void addOwningGroup(int index,
                           PrincipalGroup newValue)

Specified by:

addOwningGroup in interface SecureObject

Parameters:

index - The qualifier attribute value that qualifies the reference to get the element to be appended.

newValue - The element to be appended.

addOwningGroup

public void addOwningGroup(PrincipalGroup newValue)

Specified by:

addOwningGroup in interface SecureObject

Parameters:

newValue - The element to be appended.

removeOwningGroup

public void removeOwningGroup(int index)

Specified by:

removeOwningGroup in interface SecureObject

getOwningUser

public User getOwningUser()

Description copied from interface: SecureObject

Retrieves the value for the optional reference owningUser.

Specified by:

getOwningUser in interface SecureObject

Returns:

The possibly null value for this reference.

setOwningUser

public void setOwningUser(User newValue)

Description copied from interface: SecureObject

Sets a new value for the reference owningUser.

Specified by:

setOwningUser in interface SecureObject

Parameters:

newValue - The non-null new value for this reference.

removeOwningUser

public void removeOwningUser()

Description copied from interface: SecureObject

Removes the value for the optional reference owningUser.

Specified by:

removeOwningUser in interface SecureObject

removeAllOwningGroup

public ModifySecureObjectResult removeAllOwningGroup(RemoveAllOwningGroupParams params)
                                              throws RefException

Specified by:

removeAllOwningGroup in interface SecureObject

Throws:

RefException

removeAllOwningGroup

public ModifySecureObjectResult removeAllOwningGroup(short mode)
                                              throws RefException

Specified by:

removeAllOwningGroup in interface SecureObject

Throws:

RefException

removeOwningGroup

public ModifySecureObjectResult removeOwningGroup(ModifyOwningGroupParams params)
                                           throws RefException

Specified by:

removeOwningGroup in interface SecureObject

Throws:

RefException

removeOwningGroup

public ModifySecureObjectResult removeOwningGroup(PrincipalGroup group,
                                                  short mode)
                                           throws RefException

Specified by:

removeOwningGroup in interface SecureObject

Throws:

RefException

setAccessLevel

public ModifySecureObjectResult setAccessLevel(SetAccessLevelParams params)
                                        throws RefException

Specified by:

setAccessLevel in interface SecureObject

Throws:

RefException

setAccessLevel

public ModifySecureObjectResult setAccessLevel(short accessLevelBrowse,
                                               short accessLevelDelete,
                                               short accessLevelUpdate,
                                               short mode)
                                        throws RefException

Specified by:

setAccessLevel in interface SecureObject

Throws:

RefException

setOwningUser

public ModifySecureObjectResult setOwningUser(SetOwningUserParams params)
                                       throws RefException

Specified by:

setOwningUser in interface SecureObject

Throws:

RefException

setOwningUser

public ModifySecureObjectResult setOwningUser(short mode,
                                              User user)
                                       throws RefException

Specified by:

setOwningUser in interface SecureObject

Throws:

RefException

getDescription

public String getDescription()

Description copied from interface: DocumentFolder

Retrieves the value for the attribute description.

Specified by:

getDescription in interface DocumentFolder

Returns:

The non-null value for attribute description.

getDescription

protected String getDescription(int index)

setDescription

public void setDescription(String newValue)

Description copied from interface: DocumentFolder

Sets a new value for the attribute description.

Specified by:

setDescription in interface DocumentFolder

Parameters:

newValue - The non-null new value for attribute description.

setDescription

protected void setDescription(int index,
                              String newValue)

setDocument

protected void setDocument(List newValue)

setDocument

protected void setDocument(Document[] newValue)

getDocument

public Document getDocument(String id)

Description copied from interface: DocumentFolder

Retrieves the value for the reference document for the specified qualifier attribute value.

Specified by:

getDocument in interface DocumentFolder

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

getDocument

public Collection getDocument()

Description copied from interface: DocumentFolder

Retrieves a collection containing all the elements for the reference document.

Specified by:

getDocument in interface DocumentFolder

Returns:

A collection containing all the elements for this reference.

getDocument

public List getDocument(DocumentFilter filter)

Description copied from interface: DocumentFolder

Retrieves the value for the reference document for the specified filter.

Specified by:

getDocument in interface DocumentFolder

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

getDocument

public List getDocument(DocumentQuery query)

Description copied from interface: DocumentFolder

Retrieves the value for the reference document for the specified query.

Specified by:

getDocument in interface DocumentFolder

Returns:

The filtered collection of referenced objects.

addDocument

protected void addDocument(String id,
                           Document newValue)

addDocument

protected void addDocument(Document newValue)

removeDocument

protected void removeDocument(String id)

setFolder

protected void setFolder(List newValue)

setFolder

protected void setFolder(DocumentFolder[] newValue)

getFolder

public DocumentFolder getFolder(String id)

Description copied from interface: DocumentFolder

Retrieves the value for the reference folder for the specified qualifier attribute value.

Specified by:

getFolder in interface DocumentFolder

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

getFolder

public Collection getFolder()

Description copied from interface: DocumentFolder

Retrieves a collection containing all the elements for the reference folder.

Specified by:

getFolder in interface DocumentFolder

Returns:

A collection containing all the elements for this reference.

getFolder

public List getFolder(DocumentFolderFilter filter)

Description copied from interface: DocumentFolder

Retrieves the value for the reference folder for the specified filter.

Specified by:

getFolder in interface DocumentFolder

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

getFolder

public List getFolder(DocumentFolderQuery query)

Description copied from interface: DocumentFolder

Retrieves the value for the reference folder for the specified query.

Specified by:

getFolder in interface DocumentFolder

Returns:

The filtered collection of referenced objects.

addFolder

protected void addFolder(String id,
                         DocumentFolder newValue)

addFolder

protected void addFolder(DocumentFolder newValue)

removeFolder

protected void removeFolder(String id)

getName

public String getName()

Description copied from interface: DocumentFolder

Retrieves the value for the attribute name.

Specified by:

getName in interface DocumentFolder

Returns:

The non-null value for attribute name.

getName

protected String getName(int index)

setName

public void setName(String newValue)

Description copied from interface: DocumentFolder

Sets a new value for the attribute name.

Specified by:

setName in interface DocumentFolder

Parameters:

newValue - The non-null new value for attribute name.

setName

protected void setName(int index,
                       String newValue)

getParent

public DocumentFolder getParent()

Description copied from interface: DocumentFolder

Retrieves the value for the optional reference parent.

Specified by:

getParent in interface DocumentFolder

Returns:

The possibly null value for this reference.

setParent

public void setParent(DocumentFolder newValue)

Description copied from interface: DocumentFolder

Sets a new value for the reference parent.

Specified by:

setParent in interface DocumentFolder

Parameters:

newValue - The non-null new value for this reference.

removeParent

public void removeParent()

Description copied from interface: DocumentFolder

Removes the value for the optional reference parent.

Specified by:

removeParent in interface DocumentFolder

getCreatedAt

public Date getCreatedAt()

Description copied from interface: BasicObject

Retrieves the value for the attribute createdAt.

Specified by:

getCreatedAt in interface BasicObject

Returns:

The non-null value for attribute createdAt.

getCreatedAt

protected Date getCreatedAt(int index)

setCreatedAt

protected void setCreatedAt(Date newValue)

setCreatedAt

protected void setCreatedAt(int index,
                            Date newValue)

getCreatedBy

public Set getCreatedBy()

Specified by:

getCreatedBy in interface BasicObject

Returns:

A set containing all elements for this attribute.

setCreatedBy

protected void setCreatedBy(Set newValue)

setCreatedBy

protected void setCreatedBy(String[] newValue)

getModifiedAt

public Date getModifiedAt()

Description copied from interface: BasicObject

Retrieves the value for the attribute modifiedAt.

Specified by:

getModifiedAt in interface BasicObject

Returns:

The non-null value for attribute modifiedAt.

getModifiedAt

protected Date getModifiedAt(int index)

setModifiedAt

protected void setModifiedAt(Date newValue)

setModifiedAt

protected void setModifiedAt(int index,
                             Date newValue)

getModifiedBy

public Set getModifiedBy()

Specified by:

getModifiedBy in interface BasicObject

Returns:

A set containing all elements for this attribute.

setModifiedBy

protected void setModifiedBy(Set newValue)

setModifiedBy

protected void setModifiedBy(String[] newValue)

setContext

protected void setContext(List newValue)

setContext

protected void setContext(Context[] newValue)

getContext

public Context getContext(String id)

Description copied from interface: ContextCapable

Retrieves the value for the reference context for the specified qualifier attribute value.

Specified by:

getContext in interface ContextCapable

Parameters:

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

getContext

public Collection getContext()

Description copied from interface: ContextCapable

Retrieves the objects referenced by context.

Specified by:

getContext in interface ContextCapable

Returns:

The collection of referenced objects.

addContext

protected void addContext(String id,
                          Context newValue)

addContext

protected void addContext(Context newValue)

removeContext

protected void removeContext(String id)

getIdentity

public String getIdentity()

Description copied from interface: ExtentCapable

Retrieves the value for the attribute identity.

Specified by:

getIdentity in interface ExtentCapable

Returns:

The non-null value for attribute identity.

getIdentity

protected String getIdentity(int index)

setIdentity

protected void setIdentity(String newValue)

setIdentity

protected void setIdentity(int index,
                           String newValue)

setView

protected void setView(List newValue)

setView

protected void setView(View[] newValue)

getView

public View getView(String namespace)

Description copied from interface: ViewCapable

Retrieves the value for the reference view for the specified qualifier attribute value.

Specified by:

getView in interface ViewCapable

Parameters:

namespace - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this reference.

getView

public Collection getView()

Description copied from interface: ViewCapable

Retrieves a collection containing all the elements for the reference view.

Specified by:

getView in interface ViewCapable

Returns:

A collection containing all the elements for this reference.

getView

public List getView(ViewFilter filter)

Description copied from interface: ViewCapable

Retrieves the value for the reference view for the specified filter.

Specified by:

getView in interface ViewCapable

Parameters:

filter - filter which is applied to the set of referenced objects.

Returns:

The filtered collection of referenced objects.

getView

public List getView(ViewQuery query)

Description copied from interface: ViewCapable

Retrieves the value for the reference view for the specified query.

Specified by:

getView in interface ViewCapable

Returns:

The filtered collection of referenced objects.

addView

protected void addView(String namespace,
                       View newValue)

addView

protected void addView(View newValue)

removeView

protected void removeView(String namespace)