org.opencrx.kernel.depot1.jdo2
Class DepotEntity

java.lang.Object
  extended by org.oasisopen.jdo2.Identifiable
      extended by org.w3c.jdo2.AbstractObject
          extended by org.opencrx.kernel.depot1.jdo2.DepotEntity
All Implemented Interfaces:
Serializable, AlertSender, Auditee, Cloneable, Importer, Indexed, SecureObject, XmlExporter, DepotEntity, CrxObject, org.openmdx.base.cci2.BasicObject, org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.ExtentCapable, org.openmdx.compatibility.view1.cci2.ViewCapable

public class DepotEntity
extends org.w3c.jdo2.AbstractObject
implements DepotEntity

Class DepotEntity

See Also:
Serialized Form

Nested Class Summary
static class DepotEntity.Identity
          The object's application identity
static class DepotEntity.Slice
          Slice object hold the DepotEntity's multivalued attributes
 
Nested classes/interfaces inherited from class org.w3c.jdo2.AbstractObject
org.w3c.jdo2.AbstractObject.EmbeddedList<E>, org.w3c.jdo2.AbstractObject.EmbeddedSet<E>
 
Field Summary
static List<String> BASE_CLASS
          Define this class as base class
static List<String> CLASS
          Define the model class org::opencrx::kernel::depot1::DepotEntity
 
Constructor Summary
DepotEntity()
           
 
Method Summary
 void addAdditionalExternalLink(boolean idIsPersistent, String id, AdditionalExternalLink additionalExternalLink)
          Adds the specified element to the set of the values for the reference additionalExternalLink.
 void addAttachedDocument(boolean idIsPersistent, String id, DocumentAttachment attachedDocument)
          Adds the specified element to the set of the values for the reference attachedDocument.
 void addBookingPeriod(boolean idIsPersistent, String id, BookingPeriod bookingPeriod)
          Adds the specified element to the set of the values for the reference bookingPeriod.
 void addBookingText(boolean idIsPersistent, String id, BookingText bookingText)
          Adds the specified element to the set of the values for the reference bookingText.
 void addDepotGroup(boolean idIsPersistent, String id, DepotGroup depotGroup)
          Adds the specified element to the set of the values for the reference depotGroup.
 void addDepotHolder(boolean idIsPersistent, String id, DepotHolder depotHolder)
          Adds the specified element to the set of the values for the reference depotHolder.
 void addMedia(boolean idIsPersistent, String id, Media media)
          Adds the specified element to the set of the values for the reference media.
 void addNote(boolean idIsPersistent, String id, Note note)
          Adds the specified element to the set of the values for the reference note.
 ModifySecureObjectResult addOwningGroup(PrincipalGroup group, short mode)
           
 void addPropertySet(boolean idIsPersistent, String id, PropertySet propertySet)
          Adds the specified element to the set of the values for the reference propertySet.
 void addRating(boolean idIsPersistent, String id, Rating rating)
          Adds the specified element to the set of the values for the reference rating.
 void addToSegment(Segment segment)
          Sets a new value for the reference segment.
 void addToSegment(Segment segment, boolean idIsPersistent, String id)
          Set the object's composite association org:opencrx:kernel:depot1:SegmentContainsDepotEntity.
 CheckPermissionsResult checkPermissions(String principalName)
           
 CloneResult clone_(String referenceFilter)
           
 CreateBookingResult createBookingByPosition(BookingText bookingText, String bookingTextName, short bookingType, BookingOrigin origin, DepotPosition positionCredit, DepotPosition positionDebit, BigDecimal quantity, CompoundBooking reversalOf, Date valueDate)
           
 CreateBookingResult createBookingByPositionName(BookingText bookingText, String bookingTextName, short bookingType, Depot depotCredit, Depot depotDebit, String depotNumberCredit, String depotNumberDebit, BookingOrigin origin, String positionName, BigDecimal quantity, CompoundBooking reversalOf, Date valueDate)
           
 CreateBookingResult createBookingByProduct(BookingText bookingText, String bookingTextName, short bookingType, Depot depotCredit, Depot depotDebit, String depotNumberCredit, String depotNumberDebit, BookingOrigin origin, Product product, BigDecimal quantity, CompoundBooking reversalOf, Date valueDate)
           
 ExportResult exportXml(String attributeFilter, String referenceFilter)
           
 org.openmdx.base.cci2.BasicObject getAccessGrantedByParent()
          Retrieves the value for the reference accessGrantedByParent.
 short getAccessLevelBrowse()
          Retrieves the value for the attribute accessLevelBrowse.
 short getAccessLevelDelete()
          Retrieves the value for the attribute accessLevelDelete.
 short getAccessLevelUpdate()
          Retrieves the value for the attribute accessLevelUpdate.
<T extends AdditionalExternalLink>
Collection<T>
getAdditionalExternalLink()
          Retrieves a set containing all the elements for the reference additionalExternalLink.
 AdditionalExternalLink getAdditionalExternalLink(boolean idIsPersistent, String id)
          Retrieves the value for the reference additionalExternalLink for the specified qualifier attribute value.
<T extends DocumentAttachment>
Collection<T>
getAttachedDocument()
          Retrieves a set containing all the elements for the reference attachedDocument.
 DocumentAttachment getAttachedDocument(boolean idIsPersistent, String id)
          Retrieves the value for the reference attachedDocument for the specified qualifier attribute value.
<T extends AuditEntry>
Collection<T>
getAudit()
          Retrieves a set containing all the elements for the reference audit.
 AuditEntry getAudit(boolean idIsPersistent, String id)
          Retrieves the value for the reference audit for the specified qualifier attribute value.
<T extends BookingPeriod>
Collection<T>
getBookingPeriod()
          Retrieves a set containing all the elements for the reference bookingPeriod.
 BookingPeriod getBookingPeriod(boolean idIsPersistent, String id)
          Retrieves the value for the reference bookingPeriod for the specified qualifier attribute value.
<T extends BookingText>
Collection<T>
getBookingText()
          Retrieves a set containing all the elements for the reference bookingText.
 BookingText getBookingText(boolean idIsPersistent, String id)
          Retrieves the value for the reference bookingText for the specified qualifier attribute value.
 List<String> getCategory()
          Retrieves a list containing all the elements for the attribute category.
 Date getCreatedAt()
          Retrieves the value for the attribute createdAt.
 Set<String> getCreatedBy()
          Retrieves a set containing all the elements for the attribute createdBy.
<T extends Depot>
Collection<T>
getDepot()
          Retrieves a set containing all the elements for the reference depot.
 Depot getDepot(boolean idIsPersistent, String id)
          Retrieves the value for the reference depot for the specified qualifier attribute value.
 String getDepotEntityNumber()
          Retrieves the value for the attribute depotEntityNumber.
<T extends DepotGroup>
Collection<T>
getDepotGroup()
          Retrieves a set containing all the elements for the reference depotGroup.
 DepotGroup getDepotGroup(boolean idIsPersistent, String id)
          Retrieves the value for the reference depotGroup for the specified qualifier attribute value.
<T extends DepotHolder>
Collection<T>
getDepotHolder()
          Retrieves a set containing all the elements for the reference depotHolder.
 DepotHolder getDepotHolder(boolean idIsPersistent, String id)
          Retrieves the value for the reference depotHolder for the specified qualifier attribute value.
 String getDescription()
          Retrieves the possibly null value for the optional attribute description.
 String getDisabledReason()
          Retrieves the possibly null value for the optional attribute disabledReason.
 List<String> getExternalLink()
          Retrieves a list containing all the elements for the attribute externalLink.
 String getIdentity()
          Retrieves the value for the attribute identity.
<T extends IndexEntry>
Collection<T>
getIndexEntry()
          Retrieves a set containing all the elements for the reference indexEntry.
 IndexEntry getIndexEntry(boolean idIsPersistent, String id)
          Retrieves the value for the reference indexEntry for the specified qualifier attribute value.
<T extends Media>
Collection<T>
getMedia()
          Retrieves a set containing all the elements for the reference media.
 Media getMedia(boolean idIsPersistent, String id)
          Retrieves the value for the reference media for the specified qualifier attribute value.
 Date getModifiedAt()
          Retrieves the value for the attribute modifiedAt.
 Set<String> getModifiedBy()
          Retrieves a set containing all the elements for the attribute modifiedBy.
 String getName()
          Retrieves the value for the attribute name.
<T extends Note>
Collection<T>
getNote()
          Retrieves a set containing all the elements for the reference note.
 Note getNote(boolean idIsPersistent, String id)
          Retrieves the value for the reference note for the specified qualifier attribute value.
 List<String> getOwner()
          Retrieves a list containing all the elements for the attribute owner.
<T extends PrincipalGroup>
List<T>
getOwningGroup()
          Retrieves the Collection of objects referenced by owningGroup.
 User getOwningUser()
          Retrieves the value for the reference owningUser.
<T extends PropertySet>
Collection<T>
getPropertySet()
          Retrieves a set containing all the elements for the reference propertySet.
 PropertySet getPropertySet(boolean idIsPersistent, String id)
          Retrieves the value for the reference propertySet for the specified qualifier attribute value.
<T extends PropertySetEntry>
Collection<T>
getPropertySetEntry()
          Retrieves a set containing all the elements for the reference propertySetEntry.
 PropertySetEntry getPropertySetEntry(boolean idIsPersistent, String id)
          Retrieves the value for the reference propertySetEntry for the specified qualifier attribute value.
<T extends Rating>
Collection<T>
getRating()
          Retrieves a set containing all the elements for the reference rating.
 Rating getRating(boolean idIsPersistent, String id)
          Retrieves the value for the reference rating for the specified qualifier attribute value.
 List<Boolean> getUserBoolean4()
          Retrieves a list containing all the elements for the attribute userBoolean4.
 Short getUserCode0()
          Retrieves the possibly null value for the optional attribute userCode0.
 Short getUserCode1()
          Retrieves the possibly null value for the optional attribute userCode1.
 Short getUserCode2()
          Retrieves the possibly null value for the optional attribute userCode2.
 Short getUserCode3()
          Retrieves the possibly null value for the optional attribute userCode3.
 List<Short> getUserCode4()
          Retrieves a list containing all the elements for the attribute userCode4.
 javax.xml.datatype.XMLGregorianCalendar getUserDate0()
          Retrieves the possibly null value for the optional attribute userDate0.
 javax.xml.datatype.XMLGregorianCalendar getUserDate1()
          Retrieves the possibly null value for the optional attribute userDate1.
 javax.xml.datatype.XMLGregorianCalendar getUserDate2()
          Retrieves the possibly null value for the optional attribute userDate2.
 javax.xml.datatype.XMLGregorianCalendar getUserDate3()
          Retrieves the possibly null value for the optional attribute userDate3.
 List<javax.xml.datatype.XMLGregorianCalendar> getUserDate4()
          Retrieves a list containing all the elements for the attribute userDate4.
 Date getUserDateTime0()
          Retrieves the possibly null value for the optional attribute userDateTime0.
 Date getUserDateTime1()
          Retrieves the possibly null value for the optional attribute userDateTime1.
 Date getUserDateTime2()
          Retrieves the possibly null value for the optional attribute userDateTime2.
 Date getUserDateTime3()
          Retrieves the possibly null value for the optional attribute userDateTime3.
 List<Date> getUserDateTime4()
          Retrieves a list containing all the elements for the attribute userDateTime4.
 BigDecimal getUserNumber0()
          Retrieves the possibly null value for the optional attribute userNumber0.
 BigDecimal getUserNumber1()
          Retrieves the possibly null value for the optional attribute userNumber1.
 BigDecimal getUserNumber2()
          Retrieves the possibly null value for the optional attribute userNumber2.
 BigDecimal getUserNumber3()
          Retrieves the possibly null value for the optional attribute userNumber3.
 List<BigDecimal> getUserNumber4()
          Retrieves a list containing all the elements for the attribute userNumber4.
 String getUserString0()
          Retrieves the possibly null value for the optional attribute userString0.
 String getUserString1()
          Retrieves the possibly null value for the optional attribute userString1.
 String getUserString2()
          Retrieves the possibly null value for the optional attribute userString2.
 String getUserString3()
          Retrieves the possibly null value for the optional attribute userString3.
 List<String> getUserString4()
          Retrieves a list containing all the elements for the attribute userString4.
<T extends org.openmdx.compatibility.view1.cci2.View>
Collection<T>
getView()
          Retrieves a set containing all the elements for the reference view.
 org.openmdx.compatibility.view1.cci2.View getView(boolean namespaceIsPersistent, String namespace)
          Retrieves the value for the reference view for the specified qualifier attribute value.
 ImportResult importItem(byte[] item, String itemMimeType, String itemName, short locale)
           
 Boolean isDisabled()
          Retrieves the possibly null value for the optional attribute disabled.
 Boolean isUserBoolean0()
          Retrieves the possibly null value for the optional attribute userBoolean0.
 Boolean isUserBoolean1()
          Retrieves the possibly null value for the optional attribute userBoolean1.
 Boolean isUserBoolean2()
          Retrieves the possibly null value for the optional attribute userBoolean2.
 Boolean isUserBoolean3()
          Retrieves the possibly null value for the optional attribute userBoolean3.
static DepotEntity.Identity newIdentity(org.openmdx.base.cci2.Segment.Identity segment, boolean idIsPersistent, String id)
           
protected  org.w3c.jdo2.AbstractObject.Slice newSlice(int index)
           
protected  List<String> openmdxjdoGetClass()
          Retrieve the model class
protected  String openmdxjdoGetObjectId()
          Retrieve the object's JDO identity key
static CloseableCollection<DepotEntity> openmdxjdoGetObjectsByParent(Segment segment)
          Navigate through an object's composite association
protected  int openmdxjdoGetSize(int field)
           
protected
<E extends org.w3c.jdo2.AbstractObject.Slice>
SortedMap<Integer,E>
openmdxjdoGetSlices()
           
protected  void openmdxjdoSetSize(int field, int size)
           
static DepotEntity.Identity openmdxjdoToIdentity(org.oasisopen.spi2.ObjectId objectId)
           
 ModifySecureObjectResult removeAllOwningGroup(short mode)
           
 ModifySecureObjectResult removeOwningGroup(PrincipalGroup group, short mode)
           
 org.openmdx.base.cci2.Void sendAlert(String description, short importance, String name, org.openmdx.base.cci2.BasicObject reference, Integer resendDelayInSeconds, String toUsers)
           
 ModifySecureObjectResult setAccessLevel(short accessLevelBrowse, short accessLevelDelete, short accessLevelUpdate, short mode)
           
 void setAccessLevelBrowse(short accessLevelBrowse)
          Sets a new value for the attribute accessLevelBrowse.
 void setAccessLevelDelete(short accessLevelDelete)
          Sets a new value for the attribute accessLevelDelete.
 void setAccessLevelUpdate(short accessLevelUpdate)
          Sets a new value for the attribute accessLevelUpdate.
 void setCategory(String... category)
          Clears category and adds the given value(s).
 void setDepotEntityNumber(String depotEntityNumber)
          Sets a new value for the attribute depotEntityNumber.
 void setDescription(String description)
          Sets a new value for the attribute description.
 void setDisabled(Boolean disabled)
          Sets a new value for the attribute disabled.
 void setDisabledReason(String disabledReason)
          Sets a new value for the attribute disabledReason.
 void setExternalLink(String... externalLink)
          Clears externalLink and adds the given value(s).
 void setName(String name)
          Sets a new value for the attribute name.
 ModifySecureObjectResult setOwningUser(short mode, User user)
           
 void setOwningUser(User owningUser)
          Sets a new value for the reference owningUser.
 void setUserBoolean0(Boolean userBoolean0)
          Sets a new value for the attribute userBoolean0.
 void setUserBoolean1(Boolean userBoolean1)
          Sets a new value for the attribute userBoolean1.
 void setUserBoolean2(Boolean userBoolean2)
          Sets a new value for the attribute userBoolean2.
 void setUserBoolean3(Boolean userBoolean3)
          Sets a new value for the attribute userBoolean3.
 void setUserBoolean4(boolean... userBoolean4)
          Clears userBoolean4 and adds the given value(s).
 void setUserCode0(Short userCode0)
          Sets a new value for the attribute userCode0.
 void setUserCode1(Short userCode1)
          Sets a new value for the attribute userCode1.
 void setUserCode2(Short userCode2)
          Sets a new value for the attribute userCode2.
 void setUserCode3(Short userCode3)
          Sets a new value for the attribute userCode3.
 void setUserCode4(short... userCode4)
          Clears userCode4 and adds the given value(s).
 void setUserDate0(javax.xml.datatype.XMLGregorianCalendar userDate0)
          Sets a new value for the attribute userDate0.
 void setUserDate1(javax.xml.datatype.XMLGregorianCalendar userDate1)
          Sets a new value for the attribute userDate1.
 void setUserDate2(javax.xml.datatype.XMLGregorianCalendar userDate2)
          Sets a new value for the attribute userDate2.
 void setUserDate3(javax.xml.datatype.XMLGregorianCalendar userDate3)
          Sets a new value for the attribute userDate3.
 void setUserDate4(javax.xml.datatype.XMLGregorianCalendar... userDate4)
          Clears userDate4 and adds the given value(s).
 void setUserDateTime0(Date userDateTime0)
          Sets a new value for the attribute userDateTime0.
 void setUserDateTime1(Date userDateTime1)
          Sets a new value for the attribute userDateTime1.
 void setUserDateTime2(Date userDateTime2)
          Sets a new value for the attribute userDateTime2.
 void setUserDateTime3(Date userDateTime3)
          Sets a new value for the attribute userDateTime3.
 void setUserDateTime4(Date... userDateTime4)
          Clears userDateTime4 and adds the given value(s).
 void setUserNumber0(BigDecimal userNumber0)
          Sets a new value for the attribute userNumber0.
 void setUserNumber1(BigDecimal userNumber1)
          Sets a new value for the attribute userNumber1.
 void setUserNumber2(BigDecimal userNumber2)
          Sets a new value for the attribute userNumber2.
 void setUserNumber3(BigDecimal userNumber3)
          Sets a new value for the attribute userNumber3.
 void setUserNumber4(BigDecimal... userNumber4)
          Clears userNumber4 and adds the given value(s).
 void setUserString0(String userString0)
          Sets a new value for the attribute userString0.
 void setUserString1(String userString1)
          Sets a new value for the attribute userString1.
 void setUserString2(String userString2)
          Sets a new value for the attribute userString2.
 void setUserString3(String userString3)
          Sets a new value for the attribute userString3.
 void setUserString4(String... userString4)
          Clears userString4 and adds the given value(s).
 UpdateIndexResult updateIndex()
           
 
Methods inherited from class org.w3c.jdo2.AbstractObject
openmdxjdoClassName, openmdxjdoGetIdentityBuilder, openmdxjdoGetList, openmdxjdoGetObjectsByParent, openmdxjdoGetSet, openmdxjdoGetSparseArray, openmdxjdoNewSlice, openmdxjdoSetArray, openmdxjdoSetCollection, openmdxjdoToArray, openmdxjdoToArray, openmdxjdoValidateElement
 
Methods inherited from class org.oasisopen.jdo2.Identifiable
openmdxjdoGetObject, openmdxjdoGetObjectById, openmdxjdoGetObjectId, openmdxjdoGetObjectSet, openmdxjdoNewObjectId, openmdxjdoNewObjectId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CLASS

public static final List<String> CLASS
Define the model class org::opencrx::kernel::depot1::DepotEntity


BASE_CLASS

public static final List<String> BASE_CLASS
Define this class as base class

See Also:
DepotEntity.CLASS
Constructor Detail

DepotEntity

public DepotEntity()
Method Detail

openmdxjdoGetObjectId

protected String openmdxjdoGetObjectId()
Retrieve the object's JDO identity key

Specified by:
openmdxjdoGetObjectId in class org.oasisopen.jdo2.Identifiable
Returns:
the value of the object's JDO identity key

openmdxjdoGetSlices

protected final <E extends org.w3c.jdo2.AbstractObject.Slice> SortedMap<Integer,E> openmdxjdoGetSlices()
Overrides:
openmdxjdoGetSlices in class org.w3c.jdo2.AbstractObject

getDepotHolder

public <T extends DepotHolder> Collection<T> getDepotHolder()
Retrieves a set containing all the elements for the reference depotHolder.

Specified by:
getDepotHolder in interface DepotEntity
Returns:
A set containing all the elements for this reference.