org.opencrx.kernel.home1.jmi1

Interface WorkList

All Superinterfaces:

Auditee, org.openmdx.base.cci2.BasicObject, org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.Creatable, org.openmdx.base.cci2.ExtentCapable, org.openmdx.base.cci2.Modifiable, javax.jmi.reflect.RefBaseObject, javax.jmi.reflect.RefFeatured, javax.jmi.reflect.RefObject, org.openmdx.base.accessor.jmi.cci.RefObject_1_0, SecureObject, WorkList

public interface WorkList
extends WorkList, Auditee, SecureObject, org.openmdx.base.jmi1.BasicObject

Class WorkList

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencrx.kernel.home1.cci2.WorkList

WorkList.Identity

Method Summary

Modifier and Type	Method and Description
void	addFeed(boolean idIsPersistent, java.lang.String id, WorkListFeed feed) Adds the specified element to the set of the values for the reference feed.
void	addFeed(java.lang.String id, WorkListFeed feed) Adds the specified element to the set of the values for the reference feed using a reassignable qualifier.
void	addFeed(WorkListFeed feed) Adds the specified element to the set of the values for the reference feed using an implementation-specific, reassignable qualifier.
void	addItem(boolean idIsPersistent, java.lang.String id, WorkListItem item) Adds the specified element to the set of the values for the reference item.
void	addItem(java.lang.String id, WorkListItem item) Adds the specified element to the set of the values for the reference item using a reassignable qualifier.
void	addItem(WorkListItem item) Adds the specified element to the set of the values for the reference item using an implementation-specific, reassignable qualifier.
void	addSnapshot(boolean idIsPersistent, java.lang.String id, WorkListSnapshot snapshot) Adds the specified element to the set of the values for the reference snapshot.
void	addSnapshot(java.lang.String id, WorkListSnapshot snapshot) Adds the specified element to the set of the values for the reference snapshot using a reassignable qualifier.
void	addSnapshot(WorkListSnapshot snapshot) Adds the specified element to the set of the values for the reference snapshot using an implementation-specific, reassignable qualifier.
org.openmdx.base.jmi1.Void	createSnapshot()
WorkListSnapshot	getCurrentSnapshot() Retrieves the value for the reference currentSnapshot.
WorkListFeed	getFeed(boolean idIsPersistent, java.lang.String id) Retrieves the value for the reference feed for the specified qualifier attribute value.
WorkListFeed	getFeed(java.lang.String id) Retrieves the value for the reference feed for the specified qualifier attribute value.
<T extends WorkListFeed> java.util.List<T>	getFeed(WorkListFeedQuery query) Retrieves the value for the reference feed for the specified query.
WorkListItem	getItem(boolean idIsPersistent, java.lang.String id) Retrieves the value for the reference item for the specified qualifier attribute value.
WorkListItem	getItem(java.lang.String id) Retrieves the value for the reference item for the specified qualifier attribute value.
<T extends WorkListItem> java.util.List<T>	getItem(WorkListItemQuery query) Retrieves the value for the reference item for the specified query.
WorkListSnapshot	getSnapshot(boolean idIsPersistent, java.lang.String id) Retrieves the value for the reference snapshot for the specified qualifier attribute value.
WorkListSnapshot	getSnapshot(java.lang.String id) Retrieves the value for the reference snapshot for the specified qualifier attribute value.
<T extends WorkListSnapshot> java.util.List<T>	getSnapshot(WorkListSnapshotQuery query) Retrieves the value for the reference snapshot for the specified query.
void	setCurrentSnapshot(WorkListSnapshot currentSnapshot) Sets a new value for the reference currentSnapshot.

Methods inherited from interface org.opencrx.kernel.home1.cci2.WorkList

getDescription, getFeed, getItem, getName, getSnapshot, setDescription, setName

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

getAudit, getAudit, getAudit

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

getAudit

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

addOwningGroup, assertOwningGroup, checkPermissions, getOwner, getOwningUser, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setOwner, setOwningUser, setOwningUser

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

addOwningGroup, checkPermissions, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwningGroup, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwner, setOwningUser

Methods inherited from interface org.openmdx.base.jmi1.Creatable

getCreatedBy

Methods inherited from interface org.openmdx.base.cci2.Creatable

getCreatedAt

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

getIdentity

Methods inherited from interface org.openmdx.base.jmi1.Modifiable

getModifiedBy

Methods inherited from interface org.openmdx.base.cci2.Modifiable

getModifiedAt

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

refDefaultFetchGroup, refDelegate, refGetPath, refGetValue, refInitialize, refInitialize, refSetValue

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

createSnapshot

org.openmdx.base.jmi1.Void createSnapshot()

Specified by:

createSnapshot in interface WorkList

getCurrentSnapshot

WorkListSnapshot getCurrentSnapshot()

Retrieves the value for the reference currentSnapshot.

Specified by:

getCurrentSnapshot in interface WorkList

Returns:

The – possibly null – value for this reference.

setCurrentSnapshot

void setCurrentSnapshot(WorkListSnapshot currentSnapshot)

Sets a new value for the reference currentSnapshot.

Specified by:

setCurrentSnapshot in interface WorkList

Parameters:

currentSnapshot - The new – possibly null – value for this reference.

getFeed

<T extends WorkListFeed> java.util.List<T> getFeed(WorkListFeedQuery query)

Retrieves the value for the reference feed for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getFeed

WorkListFeed getFeed(boolean idIsPersistent,
                     java.lang.String id)

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

Parameters:

idIsPersistent - Defines whether value for the qualifier is persistent or not

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

Returns:

The possibly null value for this qualifier

getFeed

WorkListFeed getFeed(java.lang.String id)

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

This method is equivalent to the preferred invocation getFeed(false,id).

Parameters:

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

Returns:

The possibly null value for this qualifier

addFeed

void addFeed(boolean idIsPersistent,
             java.lang.String id,
             WorkListFeed feed)

Adds the specified element to the set of the values for the reference feed.

Note: This is an extension to the JMI 1 standard.

Parameters:

idIsPersistent - true if id is persistent

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

feed - The element to be appended.

addFeed

void addFeed(java.lang.String id,
             WorkListFeed feed)

Adds the specified element to the set of the values for the reference feed using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

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

feed - The element to be appended.

addFeed

void addFeed(WorkListFeed feed)

Adds the specified element to the set of the values for the reference feed using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

feed - The element to be appended.

getItem

<T extends WorkListItem> java.util.List<T> getItem(WorkListItemQuery query)

Retrieves the value for the reference item for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getItem

WorkListItem getItem(boolean idIsPersistent,
                     java.lang.String id)

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

Parameters:

idIsPersistent - Defines whether value for the qualifier is persistent or not

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

Returns:

The possibly null value for this qualifier

getItem

WorkListItem getItem(java.lang.String id)

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

This method is equivalent to the preferred invocation getItem(false,id).

Parameters:

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

Returns:

The possibly null value for this qualifier

addItem

void addItem(boolean idIsPersistent,
             java.lang.String id,
             WorkListItem item)

Adds the specified element to the set of the values for the reference item.

Note: This is an extension to the JMI 1 standard.

Parameters:

idIsPersistent - true if id is persistent

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

item - The element to be appended.

addItem

void addItem(java.lang.String id,
             WorkListItem item)

Adds the specified element to the set of the values for the reference item using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

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

item - The element to be appended.

addItem

void addItem(WorkListItem item)

Adds the specified element to the set of the values for the reference item using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

item - The element to be appended.

getSnapshot

<T extends WorkListSnapshot> java.util.List<T> getSnapshot(WorkListSnapshotQuery query)

Retrieves the value for the reference snapshot for the specified query. Note: This is an extension to the JMI 1 standard.
In order to remain standard compliant you should substitute this method with java.jdo.Query

Parameters:

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

Returns:

The objects for which the predicate evaluates to true.

getSnapshot

WorkListSnapshot getSnapshot(boolean idIsPersistent,
                             java.lang.String id)

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

Parameters:

idIsPersistent - Defines whether value for the qualifier is persistent or not

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

Returns:

The possibly null value for this qualifier

getSnapshot

WorkListSnapshot getSnapshot(java.lang.String id)

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

This method is equivalent to the preferred invocation getSnapshot(false,id).

Parameters:

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

Returns:

The possibly null value for this qualifier

addSnapshot

void addSnapshot(boolean idIsPersistent,
                 java.lang.String id,
                 WorkListSnapshot snapshot)

Adds the specified element to the set of the values for the reference snapshot.

Note: This is an extension to the JMI 1 standard.

Parameters:

idIsPersistent - true if id is persistent

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

snapshot - The element to be appended.

addSnapshot

void addSnapshot(java.lang.String id,
                 WorkListSnapshot snapshot)

Adds the specified element to the set of the values for the reference snapshot using a reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

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

snapshot - The element to be appended.

addSnapshot

void addSnapshot(WorkListSnapshot snapshot)

Adds the specified element to the set of the values for the reference snapshot using an implementation-specific, reassignable qualifier.

Note: This is an extension to the JMI 1 standard.

Parameters:

snapshot - The element to be appended.