org.opencrx.kernel.home1.jdo2
Class Subscription

java.lang.Object
  org.oasisopen.jdo2.Identifiable
      org.w3c.jdo2.AbstractObject
          org.opencrx.kernel.home1.jdo2.Subscription

All Implemented Interfaces:

Serializable, SecureObject, Subscription, BasicObject, ContextCapable, ExtentCapable, ViewCapable

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

Class Subscription

See Also:

Serialized Form

Nested Class Summary

static class	Subscription.Identity The object's application identity
static class	Subscription.Slice Slice object hold the Subscription'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::home1::Subscription

Constructor Summary

Subscription()

Method Summary

ModifySecureObjectResult	addOwningGroup(ModifyOwningGroupParams in)
void	addToUserHome(UserHome userHome) Sets a new value for the reference userHome.
void	addToUserHome(UserHome userHome, boolean idIsPersistent, String id) Set the object's composite association org:opencrx:kernel:home1:UserHomeContainsSubscription.
CheckPermissionsResult	checkPermissions(CheckPermissionsParams in)
ViewCapable	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 Context> Map<String,T>	getContext() Retrieves the Collection of objects referenced by context.
Date	getCreatedAt() Retrieves the value for the attribute createdAt.
Set<String>	getCreatedBy() Retrieves a set containing all the elements for the attribute createdBy.
String	getDescription() Retrieves the possibly null value for the optional attribute description.
Set<Short>	getEventType() Retrieves a set containing all the elements for the attribute eventType.
String	getFilterName0() Retrieves the possibly null value for the optional attribute filterName0.
String	getFilterName1() Retrieves the possibly null value for the optional attribute filterName1.
String	getFilterName2() Retrieves the possibly null value for the optional attribute filterName2.
String	getFilterName3() Retrieves the possibly null value for the optional attribute filterName3.
String	getFilterName4() Retrieves the possibly null value for the optional attribute filterName4.
Set<String>	getFilterValue0() Retrieves a set containing all the elements for the attribute filterValue0.
Set<String>	getFilterValue1() Retrieves a set containing all the elements for the attribute filterValue1.
Set<String>	getFilterValue2() Retrieves a set containing all the elements for the attribute filterValue2.
Set<String>	getFilterValue3() Retrieves a set containing all the elements for the attribute filterValue3.
Set<String>	getFilterValue4() Retrieves a set containing all the elements for the attribute filterValue4.
String	getIdentity() Retrieves the value for the attribute identity.
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.
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.
Topic	getTopic() Retrieves the value for the reference topic.
<T extends View> ObjectHasView.View<T>	getView() Retrieves a set containing all the elements for the reference view.
boolean	isActive() Retrieves the value for the attribute isActive.
static Subscription.Identity	newIdentity(UserHome.Identity userHome, QualifierType idType, 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
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 Subscription.Identity	openmdxjdoToIdentity(ObjectId objectId)
ModifySecureObjectResult	removeAllOwningGroup(RemoveAllOwningGroupParams in)
ModifySecureObjectResult	removeOwningGroup(ModifyOwningGroupParams in)
ModifySecureObjectResult	replaceOwningGroup(ModifyOwningGroupsParams in)
ModifySecureObjectResult	setAccessLevel(SetAccessLevelParams in)
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	setActive(boolean isActive) Sets a new value for the attribute isActive.
void	setDescription(String description) Sets a new value for the attribute description.
void	setEventType(Short... eventType) Clears eventType and adds the given value(s).
void	setFilterName0(String filterName0) Sets a new value for the attribute filterName0.
void	setFilterName1(String filterName1) Sets a new value for the attribute filterName1.
void	setFilterName2(String filterName2) Sets a new value for the attribute filterName2.
void	setFilterName3(String filterName3) Sets a new value for the attribute filterName3.
void	setFilterName4(String filterName4) Sets a new value for the attribute filterName4.
void	setFilterValue0(String... filterValue0) Clears filterValue0 and adds the given value(s).
void	setFilterValue1(String... filterValue1) Clears filterValue1 and adds the given value(s).
void	setFilterValue2(String... filterValue2) Clears filterValue2 and adds the given value(s).
void	setFilterValue3(String... filterValue3) Clears filterValue3 and adds the given value(s).
void	setFilterValue4(String... filterValue4) Clears filterValue4 and adds the given value(s).
void	setName(String name) Sets a new value for the attribute name.
ModifySecureObjectResult	setOwningUser(SetOwningUserParams in)
void	setOwningUser(User owningUser) Sets a new value for the reference owningUser.
void	setTopic(Topic topic) Sets a new value for the reference topic.

Methods inherited from class org.w3c.jdo2.AbstractObject

openmdxjdoClassName, openmdxjdoGetIdentityBuilder, openmdxjdoGetList, openmdxjdoGetObjectsByParent, openmdxjdoGetSet, openmdxjdoGetSparseArray, openmdxjdoNewMap, openmdxjdoNewSlice, openmdxjdoSetArray, openmdxjdoSetCollection, openmdxjdoToArray, openmdxjdoToArray, openmdxjdoValidateElement

Methods inherited from class org.oasisopen.jdo2.Identifiable

jdoClass, modelClasses, 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::home1::Subscription

BASE_CLASS

public static final List<String> BASE_CLASS

Define this class as base class

See Also:

Subscription.CLASS

Constructor Detail

Subscription

public Subscription()

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

getFilterName1

public final String getFilterName1()

Retrieves the possibly null value for the optional attribute filterName1.

Returns:

The possibly null value for attribute filterName1.

setFilterName1

public void setFilterName1(String filterName1)

Sets a new value for the attribute filterName1.

Parameters:

filterName1 - The possibly null new value for attribute filterName1.

getFilterName2

public final String getFilterName2()

Retrieves the possibly null value for the optional attribute filterName2.

Returns:

The possibly null value for attribute filterName2.

setFilterName2

public void setFilterName2(String filterName2)

Sets a new value for the attribute filterName2.

Parameters:

filterName2 - The possibly null new value for attribute filterName2.

getAccessLevelDelete

public short getAccessLevelDelete()

Retrieves the value for the attribute accessLevelDelete.

Specified by:

getAccessLevelDelete in interface SecureObject

Returns:

The non-null value for attribute accessLevelDelete.

setAccessLevelDelete

public void setAccessLevelDelete(short accessLevelDelete)

Sets a new value for the attribute accessLevelDelete.

Specified by:

setAccessLevelDelete in interface SecureObject

Parameters:

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

getFilterName0

public final String getFilterName0()

Retrieves the possibly null value for the optional attribute filterName0.

Returns:

The possibly null value for attribute filterName0.

setFilterName0

public void setFilterName0(String filterName0)

Sets a new value for the attribute filterName0.

Parameters:

filterName0 - The possibly null new value for attribute filterName0.

getModifiedAt

public Date getModifiedAt()

Retrieves the value for the attribute modifiedAt.

Specified by:

getModifiedAt in interface BasicObject

Returns:

The non-null value for attribute modifiedAt.

getModifiedBy

public final Set<String> getModifiedBy()

Retrieves a set containing all the elements for the attribute modifiedBy.

Specified by:

getModifiedBy in interface BasicObject

Returns:

A set containing all elements for this attribute.

getEventType

public final Set<Short> getEventType()

Retrieves a set containing all the elements for the attribute eventType.

Returns:

A set containing all elements for this attribute.

setEventType

public void setEventType(Short... eventType)

Clears eventType and adds the given value(s).

This method is equivalent to

   set.clear();
   set.addAll(Arrays.asList(eventType));
 

Parameters:

eventType - value(s) to be added to eventType

getAccessLevelBrowse

public short getAccessLevelBrowse()

Retrieves the value for the attribute accessLevelBrowse.

Specified by:

getAccessLevelBrowse in interface SecureObject

Returns:

The non-null value for attribute accessLevelBrowse.

setAccessLevelBrowse

public void setAccessLevelBrowse(short accessLevelBrowse)

Sets a new value for the attribute accessLevelBrowse.

Specified by:

setAccessLevelBrowse in interface SecureObject

Parameters:

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

getIdentity

public String getIdentity()

Retrieves the value for the attribute identity.

Specified by:

getIdentity in interface ExtentCapable

Returns:

The non-null value for attribute identity.

removeAllOwningGroup

public ModifySecureObjectResult removeAllOwningGroup(RemoveAllOwningGroupParams in)

Specified by:

removeAllOwningGroup in interface SecureObject

getDescription

public final String getDescription()

Retrieves the possibly null value for the optional attribute description.

Returns:

The possibly null value for attribute description.

setDescription

public void setDescription(String description)

Sets a new value for the attribute description.

Parameters:

description - The possibly null new value for attribute description.

getCreatedAt

public Date getCreatedAt()

Retrieves the value for the attribute createdAt.

Specified by:

getCreatedAt in interface BasicObject

Returns:

The non-null value for attribute createdAt.

getName

public String getName()

Retrieves the value for the attribute name.

Returns:

The non-null value for attribute name.

setName

public void setName(String name)

Sets a new value for the attribute name.

Parameters:

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

setOwningUser

public ModifySecureObjectResult setOwningUser(SetOwningUserParams in)

Specified by:

setOwningUser in interface SecureObject

getFilterName4

public final String getFilterName4()

Retrieves the possibly null value for the optional attribute filterName4.

Returns:

The possibly null value for attribute filterName4.

setFilterName4

public void setFilterName4(String filterName4)

Sets a new value for the attribute filterName4.

Parameters:

filterName4 - The possibly null new value for attribute filterName4.

getOwningGroup

public <T extends PrincipalGroup> List<T> getOwningGroup()

Retrieves the Collection of objects referenced by owningGroup.

Specified by:

getOwningGroup in interface SecureObject

Returns:

The Collection of referenced objects.

getFilterName3

public final String getFilterName3()

Retrieves the possibly null value for the optional attribute filterName3.

Returns:

The possibly null value for attribute filterName3.

setFilterName3

public void setFilterName3(String filterName3)

Sets a new value for the attribute filterName3.

Parameters:

filterName3 - The possibly null new value for attribute filterName3.

getTopic

public Topic getTopic()

Retrieves the value for the reference topic.

Returns:

The – possibly null – value for this reference.

setTopic

public void setTopic(Topic topic)

Sets a new value for the reference topic.

Parameters:

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

addOwningGroup

public ModifySecureObjectResult addOwningGroup(ModifyOwningGroupParams in)

Specified by:

addOwningGroup in interface SecureObject

checkPermissions

public CheckPermissionsResult checkPermissions(CheckPermissionsParams in)

Specified by:

checkPermissions in interface SecureObject

removeOwningGroup

public ModifySecureObjectResult removeOwningGroup(ModifyOwningGroupParams in)

Specified by:

removeOwningGroup in interface SecureObject

isActive

public boolean isActive()

Retrieves the value for the attribute isActive.

Returns:

The non-null value for attribute isActive.

setActive

public void setActive(boolean isActive)

Sets a new value for the attribute isActive.

Parameters:

isActive - The non-null new value for attribute isActive.

getAccessLevelUpdate

public short getAccessLevelUpdate()

Retrieves the value for the attribute accessLevelUpdate.

Specified by:

getAccessLevelUpdate in interface SecureObject

Returns:

The non-null value for attribute accessLevelUpdate.

setAccessLevelUpdate

public void setAccessLevelUpdate(short accessLevelUpdate)

Sets a new value for the attribute accessLevelUpdate.

Specified by:

setAccessLevelUpdate in interface SecureObject

Parameters:

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

getFilterValue0

public final Set<String> getFilterValue0()

Retrieves a set containing all the elements for the attribute filterValue0.

Returns:

A set containing all elements for this attribute.

setFilterValue0

public void setFilterValue0(String... filterValue0)

Clears filterValue0 and adds the given value(s).

This method is equivalent to

   set.clear();
   set.addAll(Arrays.asList(filterValue0));
 

Parameters:

filterValue0 - value(s) to be added to filterValue0

getCreatedBy

public final Set<String> getCreatedBy()

Retrieves a set containing all the elements for the attribute createdBy.

Specified by:

getCreatedBy in interface BasicObject

Returns:

A set containing all elements for this attribute.

getAccessGrantedByParent

public ViewCapable getAccessGrantedByParent()

Retrieves the value for the reference accessGrantedByParent.

Specified by:

getAccessGrantedByParent in interface SecureObject

Returns:

The – possibly null – value for this reference.

setAccessLevel

public ModifySecureObjectResult setAccessLevel(SetAccessLevelParams in)

Specified by:

setAccessLevel in interface SecureObject

getOwner

public final List<String> getOwner()

Retrieves a list containing all the elements for the attribute owner.

Specified by:

getOwner in interface SecureObject

Returns:

A list containing all elements for this attribute.

replaceOwningGroup

public ModifySecureObjectResult replaceOwningGroup(ModifyOwningGroupsParams in)

Specified by:

replaceOwningGroup in interface SecureObject

getContext

public <T extends Context> Map<String,T> getContext()

Retrieves the Collection of objects referenced by context.

Specified by:

getContext in interface ContextCapable

Returns:

The Collection of referenced objects.

getFilterValue4

public final Set<String> getFilterValue4()

Retrieves a set containing all the elements for the attribute filterValue4.

Returns:

A set containing all elements for this attribute.

setFilterValue4

public void setFilterValue4(String... filterValue4)

Clears filterValue4 and adds the given value(s).

This method is equivalent to

   set.clear();
   set.addAll(Arrays.asList(filterValue4));
 

Parameters:

filterValue4 - value(s) to be added to filterValue4

getFilterValue3

public final Set<String> getFilterValue3()

Retrieves a set containing all the elements for the attribute filterValue3.

Returns:

A set containing all elements for this attribute.

setFilterValue3

public void setFilterValue3(String... filterValue3)

Clears filterValue3 and adds the given value(s).

This method is equivalent to

   set.clear();
   set.addAll(Arrays.asList(filterValue3));
 

Parameters:

filterValue3 - value(s) to be added to filterValue3

getFilterValue2

public final Set<String> getFilterValue2()

Retrieves a set containing all the elements for the attribute filterValue2.

Returns:

A set containing all elements for this attribute.

setFilterValue2

public void setFilterValue2(String... filterValue2)

Clears filterValue2 and adds the given value(s).

This method is equivalent to

   set.clear();
   set.addAll(Arrays.asList(filterValue2));
 

Parameters:

filterValue2 - value(s) to be added to filterValue2

getFilterValue1

public final Set<String> getFilterValue1()

Retrieves a set containing all the elements for the attribute filterValue1.

Returns:

A set containing all elements for this attribute.

setFilterValue1

public void setFilterValue1(String... filterValue1)

Clears filterValue1 and adds the given value(s).

This method is equivalent to

   set.clear();
   set.addAll(Arrays.asList(filterValue1));
 

Parameters:

filterValue1 - value(s) to be added to filterValue1

getView

public <T extends View> ObjectHasView.View<T> getView()

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

Specified by:

getView in interface ViewCapable

Returns:

A set containing all the elements for this reference.

getOwningUser

public User getOwningUser()

Retrieves the value for the reference owningUser.

Specified by:

getOwningUser in interface SecureObject

Returns:

The – possibly null – value for this reference.

setOwningUser

public void setOwningUser(User owningUser)

Sets a new value for the reference owningUser.

Specified by:

setOwningUser in interface SecureObject

Parameters:

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

openmdxjdoGetSize

protected int openmdxjdoGetSize(int field)

Overrides:

openmdxjdoGetSize in class org.w3c.jdo2.AbstractObject

openmdxjdoSetSize

protected void openmdxjdoSetSize(int field,
                                 int size)

Overrides:

openmdxjdoSetSize in class org.w3c.jdo2.AbstractObject

newSlice

protected org.w3c.jdo2.AbstractObject.Slice newSlice(int index)

openmdxjdoGetClass

protected List<String> openmdxjdoGetClass()

Retrieve the model class

Returns:

the model class

See Also:

Subscription.CLASS

addToUserHome

public void addToUserHome(UserHome userHome)

Sets a new value for the reference userHome.

Parameters:

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

addToUserHome

public void addToUserHome(UserHome userHome,
                          boolean idIsPersistent,
                          String id)

Set the object's composite association org:opencrx:kernel:home1:UserHomeContainsSubscription.

Parameters:

userHome - The non-null new value for this object's composite owner.

idIsPersistent - Defines whether the id is persistent.

id - The non-null new value for this object's qualifier.

newIdentity

public static Subscription.Identity newIdentity(UserHome.Identity userHome,
                                                QualifierType idType,
                                                String id)

openmdxjdoToIdentity

public static Subscription.Identity openmdxjdoToIdentity(ObjectId objectId)