org.opencrx.kernel.generic.cci
Interface CrxObject

All Superinterfaces:

AlertSender, Auditee, BasicObject, Cloneable, ContextCapable, ExtentCapable, Importer, Indexed, RefBaseObject, RefFeatured, RefObject, RefObject_1_0, SecureObject, SubscriptionTarget, ViewCapable, XmlExporter

All Known Subinterfaces:

Absence, AbstractBundledProduct, AbstractGroup, AbstractInvoicePosition, AbstractOpportunityPosition, AbstractProduct, AbstractProductBundle, AbstractQuotePosition, AbstractRemovedPosition, AbstractSalesOrderPosition, AbstractTask, Account, AccountAddress, AccountAddress, AccountAssignmentInventoryItem, AccountAssignmentProduct, AccountFilterGlobal, Activity, ActivityCategory, ActivityCreationAction, ActivityCreator, ActivityFilterGlobal, ActivityFollowUp, ActivityMilestone, ActivityProcess, ActivityProcessAction, ActivityProcessState, ActivityProcessTransition, ActivityTracker, ActivityType, AddressFilterGlobal, AddressGroup, AddressGroupMember, AliasType, Artifact, ArtifactContext, ArtifactDependency, Asset, AssetContext, Association, AssociationEnd, Attribute, BehaviouralFeature, Booking, BookingPeriod, BookingText, Budget, BudgetMilestone, Building, BuildingComplex, BuildingUnit, BundledProduct, BundledProductDepotPosition, BundledProductType, CalculationRule, Calendar, Class, ClassificationElement, Classifier, CollectionType, Competitor, ComplexProductBundle, ComplexProductBundleDepotPosition, ComplexProductBundleType, CompoundBooking, Constant, Constraint, Contact, ContactMembership, ContactRelationship, ContactRole, ContractAddress, CreditBooking, CreditLimit, Datatype, DebitBooking, DeliveryInformation, DeliveryRequest, Depot, DepotContract, DepotEntity, DepotEntityRelationship, DepotGroup, DepotHolder, DepotPosition, DepotReport, DepotType, Descriptor, DescriptorGroup, DesignDiagram, DesignModel, DesignPart, Element, EMail, EMailAddress, EMailAddress, EMailAddress, EmploymentContract, EnumerationType, Event, Exception, ExternalActivity, ExternalTask, Facility, Fax, Feature, Forecast, ForecastPeriod, GeneralizableElement, Group, ImplementationPart, Import, Incident, InterfaceSpec, InventoryItem, Invoice, InvoiceBundledProductPosition, InvoiceComplexProductBundlePosition, InvoicePosition, InvoiceProductBundlePosition, InvoiceProductOfferingPosition, Lead, LegalEntity, LinkableItemLinkTo, LinkedActivityFollowUpAction, Mailing, Meeting, Member, Mms, MmsSlide, Namespace, Operation, Opportunity, OpportunityBundledProductPosition, OpportunityComplexProductBundlePosition, OpportunityPosition, OpportunityProductBundlePosition, OpportunityProductOfferingPosition, Organization, OrganizationalUnit, OrganizationalUnitRelationship, Package, Parameter, Part, PhoneCall, PhoneNumber, PhoneNumber, PhoneNumber, PostalAddress, PostalAddress, PostalAddress, PriceLevel, PriceOverrideEnabled, PricingRule, PrimitiveType, Product, ProductAddress, ProductApplication, ProductBasePrice, ProductBundle, ProductBundleContainer, ProductBundleDepotPosition, ProductBundleType, ProductClassification, ProductClassificationRelationship, ProductDepotPosition, ProductOffering, ProductOfferingDepotPosition, Profile, Quote, QuoteBundledProductPosition, QuoteComplexProductBundlePosition, QuotePosition, QuoteProductBundlePosition, QuoteProductOfferingPosition, Reference, RelatedProduct, RemovedBundledProductPosition, RemovedComplexProductBundlePosition, RemovedPosition, RemovedProductBundlePosition, RemovedProductOfferingPosition, RequirementDiagram, RequirementModel, RequirementPart, Resource, RevenueReport, Room, Room, SalesOrder, SalesOrderBundledProductPosition, SalesOrderComplexProductBundlePosition, SalesOrderPosition, SalesOrderProductBundlePosition, SalesOrderProductOfferingPosition, SalesTaxType, SalesVisit, SetActualEndAction, SetActualStartAction, SetAssignedToAction, Site, Slot, Sms, SolutionPart, StructuralFeature, StructureField, StructureType, Tag, Task, TestDiagram, TestModel, TestPart, Topic, TypedElement, UnspecifiedAccount, UseCase, VariabilityPoint, Warehouse, WebAddress, WebAddress, WebAddress, WfAction, WfProcess

All Known Implementing Classes:

AbsenceImpl, AbstractBundledProductImpl, AbstractGroupImpl, AbstractInvoicePositionImpl, AbstractOpportunityPositionImpl, AbstractProductBundleImpl, AbstractProductImpl, AbstractQuotePositionImpl, AbstractRemovedPositionImpl, AbstractSalesOrderPositionImpl, AbstractTaskImpl, AccountAddressImpl, AccountAddressImpl, AccountAssignmentInventoryItemImpl, AccountAssignmentProductImpl, AccountFilterGlobalImpl, AccountImpl, ActivityCategoryImpl, ActivityCreationActionImpl, ActivityCreatorImpl, ActivityFilterGlobalImpl, ActivityFollowUpImpl, ActivityImpl, ActivityMilestoneImpl, ActivityProcessActionImpl, ActivityProcessImpl, ActivityProcessStateImpl, ActivityProcessTransitionImpl, ActivityTrackerImpl, ActivityTypeImpl, AddressFilterGlobalImpl, AddressGroupImpl, AddressGroupMemberImpl, AliasTypeImpl, ArtifactContextImpl, ArtifactDependencyImpl, ArtifactImpl, AssetContextImpl, AssetImpl, AssociationEndImpl, AssociationImpl, AttributeImpl, BehaviouralFeatureImpl, BookingImpl, BookingPeriodImpl, BookingTextImpl, BudgetImpl, BudgetMilestoneImpl, BuildingComplexImpl, BuildingImpl, BuildingUnitImpl, BundledProductDepotPositionImpl, BundledProductImpl, BundledProductTypeImpl, CalculationRuleImpl, CalendarImpl, ClassificationElementImpl, ClassifierImpl, ClassImpl, CollectionTypeImpl, CompetitorImpl, ComplexProductBundleDepotPositionImpl, ComplexProductBundleImpl, ComplexProductBundleTypeImpl, CompoundBookingImpl, ConstantImpl, ConstraintImpl, ContactImpl, ContactMembershipImpl, ContactRelationshipImpl, ContactRoleImpl, ContractAddressImpl, CreditBookingImpl, CreditLimitImpl, CrxObjectImpl, DatatypeImpl, DebitBookingImpl, DeliveryInformationImpl, DeliveryRequestImpl, DepotContractImpl, DepotEntityImpl, DepotEntityRelationshipImpl, DepotGroupImpl, DepotHolderImpl, DepotImpl, DepotPositionImpl, DepotReportImpl, DepotTypeImpl, DescriptorGroupImpl, DescriptorImpl, DesignDiagramImpl, DesignModelImpl, DesignPartImpl, ElementImpl, EMailAddressImpl, EMailAddressImpl, EMailAddressImpl, EMailImpl, EmploymentContractImpl, EnumerationTypeImpl, EventImpl, ExceptionImpl, ExternalActivityImpl, ExternalTaskImpl, FacilityImpl, FaxImpl, FeatureImpl, ForecastImpl, ForecastPeriodImpl, GeneralizableElementImpl, GroupImpl, ImplementationPartImpl, ImportImpl, IncidentImpl, InterfaceSpecImpl, InventoryItemImpl, InvoiceBundledProductPositionImpl, InvoiceComplexProductBundlePositionImpl, InvoiceImpl, InvoicePositionImpl, InvoiceProductBundlePositionImpl, InvoiceProductOfferingPositionImpl, LeadImpl, LegalEntityImpl, LinkableItemLinkToImpl, LinkedActivityFollowUpActionImpl, MailingImpl, MeetingImpl, MemberImpl, MmsImpl, MmsSlideImpl, NamespaceImpl, OperationImpl, OpportunityBundledProductPositionImpl, OpportunityComplexProductBundlePositionImpl, OpportunityImpl, OpportunityPositionImpl, OpportunityProductBundlePositionImpl, OpportunityProductOfferingPositionImpl, OrganizationalUnitImpl, OrganizationalUnitRelationshipImpl, OrganizationImpl, PackageImpl, ParameterImpl, PartImpl, PhoneCallImpl, PhoneNumberImpl, PhoneNumberImpl, PhoneNumberImpl, PostalAddressImpl, PostalAddressImpl, PostalAddressImpl, PriceLevelImpl, PriceOverrideEnabledImpl, PricingRuleImpl, PrimitiveTypeImpl, ProductAddressImpl, ProductApplicationImpl, ProductBasePriceImpl, ProductBundleContainerImpl, ProductBundleDepotPositionImpl, ProductBundleImpl, ProductBundleTypeImpl, ProductClassificationImpl, ProductClassificationRelationshipImpl, ProductDepotPositionImpl, ProductImpl, ProductOfferingDepotPositionImpl, ProductOfferingImpl, ProfileImpl, QuoteBundledProductPositionImpl, QuoteComplexProductBundlePositionImpl, QuoteImpl, QuotePositionImpl, QuoteProductBundlePositionImpl, QuoteProductOfferingPositionImpl, ReferenceImpl, RelatedProductImpl, RemovedBundledProductPositionImpl, RemovedComplexProductBundlePositionImpl, RemovedPositionImpl, RemovedProductBundlePositionImpl, RemovedProductOfferingPositionImpl, RequirementDiagramImpl, RequirementModelImpl, RequirementPartImpl, ResourceImpl, RevenueReportImpl, RoomImpl, RoomImpl, SalesOrderBundledProductPositionImpl, SalesOrderComplexProductBundlePositionImpl, SalesOrderImpl, SalesOrderPositionImpl, SalesOrderProductBundlePositionImpl, SalesOrderProductOfferingPositionImpl, SalesTaxTypeImpl, SalesVisitImpl, SetActualEndActionImpl, SetActualStartActionImpl, SetAssignedToActionImpl, SiteImpl, SlotImpl, SmsImpl, SolutionPartImpl, StructuralFeatureImpl, StructureFieldImpl, StructureTypeImpl, TagImpl, TaskImpl, TestDiagramImpl, TestModelImpl, TestPartImpl, TopicImpl, TypedElementImpl, UnspecifiedAccountImpl, UseCaseImpl, VariabilityPointImpl, WarehouseImpl, WebAddressImpl, WebAddressImpl, WebAddressImpl, WfActionImpl, WfProcessImpl

public interface CrxObject
extends AlertSender, Auditee, Cloneable, Importer, Indexed, SecureObject, SubscriptionTarget, XmlExporter, BasicObject

Method Summary

void	addAdditionalExternalLink(AdditionalExternalLink newValue)
void	addAdditionalExternalLink(String id, AdditionalExternalLink newValue)
void	addAttachedDocument(DocumentAttachment newValue)
void	addAttachedDocument(String id, DocumentAttachment newValue)
void	addMedia(Media newValue)
void	addMedia(String id, Media newValue)
void	addNote(Note newValue)
void	addNote(String id, Note newValue)
void	addPropertySet(PropertySet newValue)
void	addPropertySet(String id, PropertySet newValue)
void	addRating(Rating newValue)
void	addRating(String id, Rating newValue)
Collection	getAdditionalExternalLink() Retrieves a collection containing all the elements for the reference additionalExternalLink.
List	getAdditionalExternalLink(AdditionalExternalLinkFilter filter) Retrieves the value for the reference additionalExternalLink for the specified filter.
List	getAdditionalExternalLink(AdditionalExternalLinkQuery query) Retrieves the value for the reference additionalExternalLink for the specified query.
AdditionalExternalLink	getAdditionalExternalLink(String id) Retrieves the value for the reference additionalExternalLink for the specified qualifier attribute value.
Collection	getAttachedDocument() Retrieves a collection containing all the elements for the reference attachedDocument.
List	getAttachedDocument(DocumentAttachmentFilter filter) Retrieves the value for the reference attachedDocument for the specified filter.
List	getAttachedDocument(DocumentAttachmentQuery query) Retrieves the value for the reference attachedDocument for the specified query.
DocumentAttachment	getAttachedDocument(String id) Retrieves the value for the reference attachedDocument for the specified qualifier attribute value.
List	getCategory()
String	getCategory(int index)
String	getDisabledReason()
List	getExternalLink()
String	getExternalLink(int index)
Collection	getMedia() Retrieves a collection containing all the elements for the reference media.
List	getMedia(MediaFilter filter) Retrieves the value for the reference media for the specified filter.
List	getMedia(MediaQuery query) Retrieves the value for the reference media for the specified query.
Media	getMedia(String id) Retrieves the value for the reference media for the specified qualifier attribute value.
Collection	getNote() Retrieves a collection containing all the elements for the reference note.
List	getNote(NoteFilter filter) Retrieves the value for the reference note for the specified filter.
List	getNote(NoteQuery query) Retrieves the value for the reference note for the specified query.
Note	getNote(String id) Retrieves the value for the reference note for the specified qualifier attribute value.
Collection	getPropertySet() Retrieves a collection containing all the elements for the reference propertySet.
List	getPropertySet(PropertySetFilter filter) Retrieves the value for the reference propertySet for the specified filter.
List	getPropertySet(PropertySetQuery query) Retrieves the value for the reference propertySet for the specified query.
PropertySet	getPropertySet(String id) Retrieves the value for the reference propertySet for the specified qualifier attribute value.
Collection	getPropertySetEntry() Retrieves a collection containing all the elements for the reference propertySetEntry.
List	getPropertySetEntry(PropertySetEntryFilter filter) Retrieves the value for the reference propertySetEntry for the specified filter.
List	getPropertySetEntry(PropertySetEntryQuery query) Retrieves the value for the reference propertySetEntry for the specified query.
PropertySetEntry	getPropertySetEntry(String id) Retrieves the value for the reference propertySetEntry for the specified qualifier attribute value.
Collection	getRating() Retrieves a collection containing all the elements for the reference rating.
List	getRating(RatingFilter filter) Retrieves the value for the reference rating for the specified filter.
List	getRating(RatingQuery query) Retrieves the value for the reference rating for the specified query.
Rating	getRating(String id) Retrieves the value for the reference rating for the specified qualifier attribute value.
Short	getUserCode0()
Short	getUserCode1()
Short	getUserCode2()
Short	getUserCode3()
List	getUserCode4()
short	getUserCode4(int index)
javax.xml.datatype.XMLGregorianCalendar	getUserDate0()
javax.xml.datatype.XMLGregorianCalendar	getUserDate1()
javax.xml.datatype.XMLGregorianCalendar	getUserDate2()
javax.xml.datatype.XMLGregorianCalendar	getUserDate3()
List	getUserDate4()
javax.xml.datatype.XMLGregorianCalendar	getUserDate4(int index)
Date	getUserDateTime0()
Date	getUserDateTime1()
Date	getUserDateTime2()
Date	getUserDateTime3()
List	getUserDateTime4()
Date	getUserDateTime4(int index)
BigDecimal	getUserNumber0()
BigDecimal	getUserNumber1()
BigDecimal	getUserNumber2()
BigDecimal	getUserNumber3()
List	getUserNumber4()
BigDecimal	getUserNumber4(int index)
String	getUserString0()
String	getUserString1()
String	getUserString2()
String	getUserString3()
List	getUserString4()
String	getUserString4(int index)
boolean	isDisabled() Retrieves the value for the attribute disabled.
Boolean	isUserBoolean0()
Boolean	isUserBoolean1()
Boolean	isUserBoolean2()
Boolean	isUserBoolean3()
List	isUserBoolean4()
boolean	isUserBoolean4(int index)
void	removeAdditionalExternalLink(String id)
void	removeAttachedDocument(String id)
void	removeMedia(String id)
void	removeNote(String id)
void	removePropertySet(String id)
void	removeRating(String id)
void	setCategory(List newValue)
void	setCategory(String[] newValue)
void	setDisabled(boolean newValue) Sets a new value for the attribute disabled.
void	setDisabledReason(String newValue) Sets a new value for the attribute disabledReason.
void	setExternalLink(List newValue)
void	setExternalLink(String[] newValue)
void	setUserBoolean0(Boolean newValue) Sets a new value for the attribute userBoolean0.
void	setUserBoolean1(Boolean newValue) Sets a new value for the attribute userBoolean1.
void	setUserBoolean2(Boolean newValue) Sets a new value for the attribute userBoolean2.
void	setUserBoolean3(Boolean newValue) Sets a new value for the attribute userBoolean3.
void	setUserBoolean4(boolean[] newValue)
void	setUserBoolean4(List newValue)
void	setUserCode0(Short newValue) Sets a new value for the attribute userCode0.
void	setUserCode1(Short newValue) Sets a new value for the attribute userCode1.
void	setUserCode2(Short newValue) Sets a new value for the attribute userCode2.
void	setUserCode3(Short newValue) Sets a new value for the attribute userCode3.
void	setUserCode4(List newValue)
void	setUserCode4(short[] newValue)
void	setUserDate0(javax.xml.datatype.XMLGregorianCalendar newValue) Sets a new value for the attribute userDate0.
void	setUserDate1(javax.xml.datatype.XMLGregorianCalendar newValue) Sets a new value for the attribute userDate1.
void	setUserDate2(javax.xml.datatype.XMLGregorianCalendar newValue) Sets a new value for the attribute userDate2.
void	setUserDate3(javax.xml.datatype.XMLGregorianCalendar newValue) Sets a new value for the attribute userDate3.
void	setUserDate4(List newValue)
void	setUserDate4(javax.xml.datatype.XMLGregorianCalendar[] newValue)
void	setUserDateTime0(Date newValue) Sets a new value for the attribute userDateTime0.
void	setUserDateTime1(Date newValue) Sets a new value for the attribute userDateTime1.
void	setUserDateTime2(Date newValue) Sets a new value for the attribute userDateTime2.
void	setUserDateTime3(Date newValue) Sets a new value for the attribute userDateTime3.
void	setUserDateTime4(Date[] newValue)
void	setUserDateTime4(List newValue)
void	setUserNumber0(BigDecimal newValue) Sets a new value for the attribute userNumber0.
void	setUserNumber1(BigDecimal newValue) Sets a new value for the attribute userNumber1.
void	setUserNumber2(BigDecimal newValue) Sets a new value for the attribute userNumber2.
void	setUserNumber3(BigDecimal newValue) Sets a new value for the attribute userNumber3.
void	setUserNumber4(BigDecimal[] newValue)
void	setUserNumber4(List newValue)
void	setUserString0(String newValue) Sets a new value for the attribute userString0.
void	setUserString1(String newValue) Sets a new value for the attribute userString1.
void	setUserString2(String newValue) Sets a new value for the attribute userString2.
void	setUserString3(String newValue) Sets a new value for the attribute userString3.
void	setUserString4(List newValue)
void	setUserString4(String[] newValue)

Methods inherited from interface org.opencrx.kernel.base.cci.AlertSender

sendAlert, sendAlert

Methods inherited from interface org.opencrx.kernel.base.cci.Auditee

getAudit, getAudit, getAudit, getAudit

Methods inherited from interface org.opencrx.kernel.base.cci.Cloneable

clone_, clone_

Methods inherited from interface org.opencrx.kernel.base.cci.Importer

importItem, importItem

Methods inherited from interface org.opencrx.kernel.base.cci.Indexed

getIndexEntry, getIndexEntry, getIndexEntry, getIndexEntry, updateIndex, updateIndex

Methods inherited from interface org.opencrx.kernel.base.cci.SecureObject

addOwningGroup, addOwningGroup, addOwningGroup, addOwningGroup, getAccessGrantedByParent, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwner, getOwningGroup, getOwningGroup, getOwningUser, removeAllOwningGroup, removeAllOwningGroup, removeOwningGroup, removeOwningGroup, removeOwningGroup, removeOwningUser, setAccessLevel, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwningUser, setOwningUser, setOwningUser

Methods inherited from interface org.opencrx.kernel.base.cci.SubscriptionTarget

addSubscription, addSubscription, addSubscriptionForParent, addSubscriptionForParent, removeSubscription, removeSubscription, removeSubscriptionForParent, removeSubscriptionForParent

Methods inherited from interface org.opencrx.kernel.base.cci.XmlExporter

exportXml, exportXml

Methods inherited from interface org.openmdx.base.cci.BasicObject

getCreatedAt, getCreatedBy, getModifiedAt, getModifiedBy

Methods inherited from interface org.openmdx.base.cci.ContextCapable

getContext, getContext

Methods inherited from interface org.openmdx.base.cci.ExtentCapable

getIdentity

Methods inherited from interface org.openmdx.compatibility.view1.cci.ViewCapable

getView, getView, getView, getView

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

Method Detail

getAdditionalExternalLink

AdditionalExternalLink getAdditionalExternalLink(String id)

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

Parameters:

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

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getAdditionalExternalLink

Collection getAdditionalExternalLink()

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

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getAdditionalExternalLink

List getAdditionalExternalLink(AdditionalExternalLinkFilter filter)

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

Parameters:

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

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getAdditionalExternalLink

List getAdditionalExternalLink(AdditionalExternalLinkQuery query)

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

Parameters:

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

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

addAdditionalExternalLink

void addAdditionalExternalLink(String id,
                               AdditionalExternalLink newValue)

Parameters:

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

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

addAdditionalExternalLink

void addAdditionalExternalLink(AdditionalExternalLink newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removeAdditionalExternalLink

void removeAdditionalExternalLink(String id)

Throws:

JmiException - If the value cannot be removed for some reason.

getAttachedDocument

DocumentAttachment getAttachedDocument(String id)

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

Parameters:

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

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getAttachedDocument

Collection getAttachedDocument()

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

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getAttachedDocument

List getAttachedDocument(DocumentAttachmentFilter filter)

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

Parameters:

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

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getAttachedDocument

List getAttachedDocument(DocumentAttachmentQuery query)

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

Parameters:

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

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

addAttachedDocument

void addAttachedDocument(String id,
                         DocumentAttachment newValue)

Parameters:

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

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

addAttachedDocument

void addAttachedDocument(DocumentAttachment newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removeAttachedDocument

void removeAttachedDocument(String id)

Throws:

JmiException - If the value cannot be removed for some reason.

getCategory

List getCategory()

Returns:

A list containing all elements for this attribute.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getCategory

String getCategory(int index)

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.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setCategory

void setCategory(List newValue)

Parameters:

newValue - A list containing all the new elements for this attribute.

Throws:

JmiException - If the values cannot be set for some reason.

setCategory

void setCategory(String[] newValue)

Parameters:

newValue - An array containing all the new elements for this attribute.

Throws:

JmiException - If the values cannot be set for some reason.

isDisabled

boolean isDisabled()

Retrieves the value for the attribute disabled.

Returns:

The non-null value for attribute disabled.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setDisabled

void setDisabled(boolean newValue)

Sets a new value for the attribute disabled.

Parameters:

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

Throws:

JmiException - If the value cannot be set for some reason.

getDisabledReason

String getDisabledReason()

Returns:

The possibly null value for attribute disabledReason.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setDisabledReason

void setDisabledReason(String newValue)

Sets a new value for the attribute disabledReason.

Parameters:

newValue - The possibly null new value for attribute disabledReason.

Throws:

JmiException - If the value cannot be set for some reason.

getExternalLink

List getExternalLink()

Returns:

A list containing all elements for this attribute.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getExternalLink

String getExternalLink(int index)

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.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setExternalLink

void setExternalLink(List newValue)

Parameters:

newValue - A list containing all the new elements for this attribute.

Throws:

JmiException - If the values cannot be set for some reason.

setExternalLink

void setExternalLink(String[] newValue)

Parameters:

newValue - An array containing all the new elements for this attribute.

Throws:

JmiException - If the values cannot be set for some reason.

getMedia

Media getMedia(String id)

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

Parameters:

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

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getMedia

Collection getMedia()

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

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getMedia

List getMedia(MediaFilter filter)

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

Parameters:

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

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getMedia

List getMedia(MediaQuery query)

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

Parameters:

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

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

addMedia

void addMedia(String id,
              Media newValue)

Parameters:

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

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

addMedia

void addMedia(Media newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removeMedia

void removeMedia(String id)

Throws:

JmiException - If the value cannot be removed for some reason.

getNote

Note getNote(String id)

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

Parameters:

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

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getNote

Collection getNote()

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

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getNote

List getNote(NoteFilter filter)

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

Parameters:

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

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getNote

List getNote(NoteQuery query)

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

Parameters:

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

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

addNote

void addNote(String id,
             Note newValue)

Parameters:

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

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

addNote

void addNote(Note newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removeNote

void removeNote(String id)

Throws:

JmiException - If the value cannot be removed for some reason.

getPropertySet

PropertySet getPropertySet(String id)

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

Parameters:

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

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getPropertySet

Collection getPropertySet()

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

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getPropertySet

List getPropertySet(PropertySetFilter filter)

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

Parameters:

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

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getPropertySet

List getPropertySet(PropertySetQuery query)

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

Parameters:

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

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

addPropertySet

void addPropertySet(String id,
                    PropertySet newValue)

Parameters:

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

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

addPropertySet

void addPropertySet(PropertySet newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removePropertySet

void removePropertySet(String id)

Throws:

JmiException - If the value cannot be removed for some reason.

getPropertySetEntry

PropertySetEntry getPropertySetEntry(String id)

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

Parameters:

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

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getPropertySetEntry

Collection getPropertySetEntry()

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

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getPropertySetEntry

List getPropertySetEntry(PropertySetEntryFilter filter)

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

Parameters:

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

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getPropertySetEntry

List getPropertySetEntry(PropertySetEntryQuery query)

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

Parameters:

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

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getRating

Rating getRating(String id)

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

Parameters:

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

Returns:

The possibly null value for this reference.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getRating

Collection getRating()

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

Returns:

A collection containing all the elements for this reference.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getRating

List getRating(RatingFilter filter)

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

Parameters:

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

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

getRating

List getRating(RatingQuery query)

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

Parameters:

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

Returns:

The filtered collection of referenced objects.

Throws:

JmiException - If the value cannot be retrieved for some reason.

addRating

void addRating(String id,
               Rating newValue)

Parameters:

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

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

addRating

void addRating(Rating newValue)

Parameters:

newValue - The element to be appended.

Throws:

JmiException - If the value cannot be appended for some reason.

removeRating

void removeRating(String id)

Throws:

JmiException - If the value cannot be removed for some reason.

isUserBoolean0

Boolean isUserBoolean0()

Returns:

The possibly null value for attribute userBoolean0.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserBoolean0

void setUserBoolean0(Boolean newValue)

Sets a new value for the attribute userBoolean0.

Parameters:

newValue - The possibly null new value for attribute userBoolean0.

Throws:

JmiException - If the value cannot be set for some reason.

isUserBoolean1

Boolean isUserBoolean1()

Returns:

The possibly null value for attribute userBoolean1.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserBoolean1

void setUserBoolean1(Boolean newValue)

Sets a new value for the attribute userBoolean1.

Parameters:

newValue - The possibly null new value for attribute userBoolean1.

Throws:

JmiException - If the value cannot be set for some reason.

isUserBoolean2

Boolean isUserBoolean2()

Returns:

The possibly null value for attribute userBoolean2.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserBoolean2

void setUserBoolean2(Boolean newValue)

Sets a new value for the attribute userBoolean2.

Parameters:

newValue - The possibly null new value for attribute userBoolean2.

Throws:

JmiException - If the value cannot be set for some reason.

isUserBoolean3

Boolean isUserBoolean3()

Returns:

The possibly null value for attribute userBoolean3.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserBoolean3

void setUserBoolean3(Boolean newValue)

Sets a new value for the attribute userBoolean3.

Parameters:

newValue - The possibly null new value for attribute userBoolean3.

Throws:

JmiException - If the value cannot be set for some reason.

isUserBoolean4

List isUserBoolean4()

Returns:

A list containing all elements for this attribute.

Throws:

JmiException - If the values cannot be retrieved for some reason.

isUserBoolean4

boolean isUserBoolean4(int index)

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.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserBoolean4

void setUserBoolean4(List newValue)

Parameters:

newValue - A list containing all the new elements for this attribute.

Throws:

JmiException - If the values cannot be set for some reason.

setUserBoolean4

void setUserBoolean4(boolean[] newValue)

Parameters:

newValue - An array containing all the new elements for this attribute.

Throws:

JmiException - If the values cannot be set for some reason.

getUserCode0

Short getUserCode0()

Returns:

The possibly null value for attribute userCode0.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserCode0

void setUserCode0(Short newValue)

Sets a new value for the attribute userCode0.

Parameters:

newValue - The possibly null new value for attribute userCode0.

Throws:

JmiException - If the value cannot be set for some reason.

getUserCode1

Short getUserCode1()

Returns:

The possibly null value for attribute userCode1.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserCode1

void setUserCode1(Short newValue)

Sets a new value for the attribute userCode1.

Parameters:

newValue - The possibly null new value for attribute userCode1.

Throws:

JmiException - If the value cannot be set for some reason.

getUserCode2

Short getUserCode2()

Returns:

The possibly null value for attribute userCode2.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserCode2

void setUserCode2(Short newValue)

Sets a new value for the attribute userCode2.

Parameters:

newValue - The possibly null new value for attribute userCode2.

Throws:

JmiException - If the value cannot be set for some reason.

getUserCode3

Short getUserCode3()

Returns:

The possibly null value for attribute userCode3.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserCode3

void setUserCode3(Short newValue)

Sets a new value for the attribute userCode3.

Parameters:

newValue - The possibly null new value for attribute userCode3.

Throws:

JmiException - If the value cannot be set for some reason.

getUserCode4

List getUserCode4()

Returns:

A list containing all elements for this attribute.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getUserCode4

short getUserCode4(int index)

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.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserCode4

void setUserCode4(List newValue)

Parameters:

newValue - A list containing all the new elements for this attribute.

Throws:

JmiException - If the values cannot be set for some reason.

setUserCode4

void setUserCode4(short[] newValue)

Parameters:

newValue - An array containing all the new elements for this attribute.

Throws:

JmiException - If the values cannot be set for some reason.

getUserDate0

javax.xml.datatype.XMLGregorianCalendar getUserDate0()

Returns:

The possibly null value for attribute userDate0.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserDate0

void setUserDate0(javax.xml.datatype.XMLGregorianCalendar newValue)

Sets a new value for the attribute userDate0.

Parameters:

newValue - The possibly null new value for attribute userDate0.

Throws:

JmiException - If the value cannot be set for some reason.

getUserDate1

javax.xml.datatype.XMLGregorianCalendar getUserDate1()

Returns:

The possibly null value for attribute userDate1.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserDate1

void setUserDate1(javax.xml.datatype.XMLGregorianCalendar newValue)

Sets a new value for the attribute userDate1.

Parameters:

newValue - The possibly null new value for attribute userDate1.

Throws:

JmiException - If the value cannot be set for some reason.

getUserDate2

javax.xml.datatype.XMLGregorianCalendar getUserDate2()

Returns:

The possibly null value for attribute userDate2.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserDate2

void setUserDate2(javax.xml.datatype.XMLGregorianCalendar newValue)

Sets a new value for the attribute userDate2.

Parameters:

newValue - The possibly null new value for attribute userDate2.

Throws:

JmiException - If the value cannot be set for some reason.

getUserDate3

javax.xml.datatype.XMLGregorianCalendar getUserDate3()

Returns:

The possibly null value for attribute userDate3.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserDate3

void setUserDate3(javax.xml.datatype.XMLGregorianCalendar newValue)

Sets a new value for the attribute userDate3.

Parameters:

newValue - The possibly null new value for attribute userDate3.

Throws:

JmiException - If the value cannot be set for some reason.

getUserDate4

List getUserDate4()

Returns:

A list containing all elements for this attribute.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getUserDate4

javax.xml.datatype.XMLGregorianCalendar getUserDate4(int index)

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.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserDate4

void setUserDate4(List newValue)

Parameters:

newValue - A list containing all the new elements for this attribute.

Throws:

JmiException - If the values cannot be set for some reason.

setUserDate4

void setUserDate4(javax.xml.datatype.XMLGregorianCalendar[] newValue)

Parameters:

newValue - An array containing all the new elements for this attribute.

Throws:

JmiException - If the values cannot be set for some reason.

getUserDateTime0

Date getUserDateTime0()

Returns:

The possibly null value for attribute userDateTime0.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserDateTime0

void setUserDateTime0(Date newValue)

Sets a new value for the attribute userDateTime0.

Parameters:

newValue - The possibly null new value for attribute userDateTime0.

Throws:

JmiException - If the value cannot be set for some reason.

getUserDateTime1

Date getUserDateTime1()

Returns:

The possibly null value for attribute userDateTime1.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserDateTime1

void setUserDateTime1(Date newValue)

Sets a new value for the attribute userDateTime1.

Parameters:

newValue - The possibly null new value for attribute userDateTime1.

Throws:

JmiException - If the value cannot be set for some reason.

getUserDateTime2

Date getUserDateTime2()

Returns:

The possibly null value for attribute userDateTime2.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserDateTime2

void setUserDateTime2(Date newValue)

Sets a new value for the attribute userDateTime2.

Parameters:

newValue - The possibly null new value for attribute userDateTime2.

Throws:

JmiException - If the value cannot be set for some reason.

getUserDateTime3

Date getUserDateTime3()

Returns:

The possibly null value for attribute userDateTime3.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserDateTime3

void setUserDateTime3(Date newValue)

Sets a new value for the attribute userDateTime3.

Parameters:

newValue - The possibly null new value for attribute userDateTime3.

Throws:

JmiException - If the value cannot be set for some reason.

getUserDateTime4

List getUserDateTime4()

Returns:

A list containing all elements for this attribute.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getUserDateTime4

Date getUserDateTime4(int index)

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.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserDateTime4

void setUserDateTime4(List newValue)

Parameters:

newValue - A list containing all the new elements for this attribute.

Throws:

JmiException - If the values cannot be set for some reason.

setUserDateTime4

void setUserDateTime4(Date[] newValue)

Parameters:

newValue - An array containing all the new elements for this attribute.

Throws:

JmiException - If the values cannot be set for some reason.

getUserNumber0

BigDecimal getUserNumber0()

Returns:

The possibly null value for attribute userNumber0.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserNumber0

void setUserNumber0(BigDecimal newValue)

Sets a new value for the attribute userNumber0.

Parameters:

newValue - The possibly null new value for attribute userNumber0.

Throws:

JmiException - If the value cannot be set for some reason.

getUserNumber1

BigDecimal getUserNumber1()

Returns:

The possibly null value for attribute userNumber1.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserNumber1

void setUserNumber1(BigDecimal newValue)

Sets a new value for the attribute userNumber1.

Parameters:

newValue - The possibly null new value for attribute userNumber1.

Throws:

JmiException - If the value cannot be set for some reason.

getUserNumber2

BigDecimal getUserNumber2()

Returns:

The possibly null value for attribute userNumber2.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserNumber2

void setUserNumber2(BigDecimal newValue)

Sets a new value for the attribute userNumber2.

Parameters:

newValue - The possibly null new value for attribute userNumber2.

Throws:

JmiException - If the value cannot be set for some reason.

getUserNumber3

BigDecimal getUserNumber3()

Returns:

The possibly null value for attribute userNumber3.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserNumber3

void setUserNumber3(BigDecimal newValue)

Sets a new value for the attribute userNumber3.

Parameters:

newValue - The possibly null new value for attribute userNumber3.

Throws:

JmiException - If the value cannot be set for some reason.

getUserNumber4

List getUserNumber4()

Returns:

A list containing all elements for this attribute.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getUserNumber4

BigDecimal getUserNumber4(int index)

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.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserNumber4

void setUserNumber4(List newValue)

Parameters:

newValue - A list containing all the new elements for this attribute.

Throws:

JmiException - If the values cannot be set for some reason.

setUserNumber4

void setUserNumber4(BigDecimal[] newValue)

Parameters:

newValue - An array containing all the new elements for this attribute.

Throws:

JmiException - If the values cannot be set for some reason.

getUserString0

String getUserString0()

Returns:

The possibly null value for attribute userString0.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserString0

void setUserString0(String newValue)

Sets a new value for the attribute userString0.

Parameters:

newValue - The possibly null new value for attribute userString0.

Throws:

JmiException - If the value cannot be set for some reason.

getUserString1

String getUserString1()

Returns:

The possibly null value for attribute userString1.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserString1

void setUserString1(String newValue)

Sets a new value for the attribute userString1.

Parameters:

newValue - The possibly null new value for attribute userString1.

Throws:

JmiException - If the value cannot be set for some reason.

getUserString2

String getUserString2()

Returns:

The possibly null value for attribute userString2.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserString2

void setUserString2(String newValue)

Sets a new value for the attribute userString2.

Parameters:

newValue - The possibly null new value for attribute userString2.

Throws:

JmiException - If the value cannot be set for some reason.

getUserString3

String getUserString3()

Returns:

The possibly null value for attribute userString3.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserString3

void setUserString3(String newValue)

Sets a new value for the attribute userString3.

Parameters:

newValue - The possibly null new value for attribute userString3.

Throws:

JmiException - If the value cannot be set for some reason.

getUserString4

List getUserString4()

Returns:

A list containing all elements for this attribute.

Throws:

JmiException - If the values cannot be retrieved for some reason.

getUserString4

String getUserString4(int index)

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.

Throws:

JmiException - If the value cannot be retrieved for some reason.

setUserString4

void setUserString4(List newValue)

Parameters:

newValue - A list containing all the new elements for this attribute.

Throws:

JmiException - If the values cannot be set for some reason.

setUserString4

void setUserString4(String[] newValue)

Parameters:

newValue - An array containing all the new elements for this attribute.

Throws:

JmiException - If the values cannot be set for some reason.