org.opencrx.kernel.home1.jdo2
Class QuickAccess

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

All Implemented Interfaces:

Serializable, SecureObject, QuickAccess, AspectCapable, BasicObject, ContextCapable, Creatable, ExtentCapable, Modifiable

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

Class QuickAccess

See Also:

Serialized Form

Nested Class Summary

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

Constructor Summary

QuickAccess()

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:UserHomeContainsQuickAccess.
CheckPermissionsResult	checkPermissions(CheckPermissionsParams in)
ContextCapable	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.
String	getActionName() Retrieves the possibly null value for the optional attribute actionName.
List<String>	getActionParam() Retrieves a list containing all the elements for the attribute actionParam.
short	getActionType() Retrieves the value for the attribute actionType.
<T extends Context> Map<String,T>	getContext() Retrieves the Mao 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.
String	getIconKey() Retrieves the possibly null value for the optional attribute iconKey.
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 possibly null value for the optional 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.
ContextCapable	getReference() Retrieves the value for the reference reference.
static QuickAccess.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 QuickAccess.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	setActionName(String actionName) Sets a new value for the attribute actionName.
void	setActionParam(String... actionParam) Clears actionParam and adds the given value(s).
void	setActionType(short actionType) Sets a new value for the attribute actionType.
void	setDescription(String description) Sets a new value for the attribute description.
void	setIconKey(String iconKey) Sets a new value for the attribute iconKey.
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	setReference(ContextCapable reference) Sets a new value for the reference reference.

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::QuickAccess

BASE_CLASS

public static final List<String> BASE_CLASS

Define this class as base class

See Also:

QuickAccess.CLASS

Constructor Detail

QuickAccess

public QuickAccess()

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

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.

getModifiedAt

public Date getModifiedAt()

Retrieves the value for the attribute modifiedAt.

Specified by:

getModifiedAt in interface Modifiable

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 Modifiable

Returns:

A set containing all elements for this attribute.

getActionName

public final String getActionName()

Retrieves the possibly null value for the optional attribute actionName.

Specified by:

getActionName in interface QuickAccess

Returns:

The possibly null value for attribute actionName.

setActionName

public void setActionName(String actionName)

Sets a new value for the attribute actionName.

Specified by:

setActionName in interface QuickAccess

Parameters:

actionName - The possibly null new value for attribute actionName.

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.

getDescription

public final String getDescription()

Retrieves the possibly null value for the optional attribute description.

Specified by:

getDescription in interface QuickAccess

Returns:

The possibly null value for attribute description.

setDescription

public void setDescription(String description)

Sets a new value for the attribute description.

Specified by:

setDescription in interface QuickAccess

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 Creatable

Returns:

The non-null value for attribute createdAt.

removeAllOwningGroup

public ModifySecureObjectResult removeAllOwningGroup(RemoveAllOwningGroupParams in)

Specified by:

removeAllOwningGroup in interface SecureObject

getName

public final String getName()

Retrieves the possibly null value for the optional attribute name.

Specified by:

getName in interface QuickAccess

Returns:

The possibly null value for attribute name.

setName

public void setName(String name)

Sets a new value for the attribute name.

Specified by:

setName in interface QuickAccess

Parameters:

name - The possibly null new value for attribute name.

setOwningUser

public ModifySecureObjectResult setOwningUser(SetOwningUserParams in)

Specified by:

setOwningUser in interface SecureObject

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.

addOwningGroup

public ModifySecureObjectResult addOwningGroup(ModifyOwningGroupParams in)

Specified by:

addOwningGroup in interface SecureObject

checkPermissions

public CheckPermissionsResult checkPermissions(CheckPermissionsParams in)

Specified by:

checkPermissions in interface SecureObject

getActionType

public short getActionType()

Retrieves the value for the attribute actionType.

Specified by:

getActionType in interface QuickAccess

Returns:

The non-null value for attribute actionType.

setActionType

public void setActionType(short actionType)

Sets a new value for the attribute actionType.

Specified by:

setActionType in interface QuickAccess

Parameters:

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

getActionParam

public final List<String> getActionParam()

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

Specified by:

getActionParam in interface QuickAccess

Returns:

A list containing all elements for this attribute.

setActionParam

public void setActionParam(String... actionParam)

Clears actionParam and adds the given value(s).

This method is equivalent to

   list.clear();
   for(java.lang.String e : attributeName){
     list.add(e);
   }
 

Specified by:

setActionParam in interface QuickAccess

Parameters:

actionParam - value(s) to be added to actionParam

removeOwningGroup

public ModifySecureObjectResult removeOwningGroup(ModifyOwningGroupParams in)

Specified by:

removeOwningGroup in interface SecureObject

getReference

public ContextCapable getReference()

Retrieves the value for the reference reference.

Specified by:

getReference in interface QuickAccess

Returns:

The – possibly null – value for this reference.

setReference

public void setReference(ContextCapable reference)

Sets a new value for the reference reference.

Specified by:

setReference in interface QuickAccess

Parameters:

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

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.

getCreatedBy

public final Set<String> getCreatedBy()

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

Specified by:

getCreatedBy in interface Creatable

Returns:

A set containing all elements for this attribute.

getAccessGrantedByParent

public ContextCapable 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 Mao of objects referenced by context.

Specified by:

getContext in interface ContextCapable

Returns:

The Map of referenced objects.

getIconKey

public final String getIconKey()

Retrieves the possibly null value for the optional attribute iconKey.

Specified by:

getIconKey in interface QuickAccess

Returns:

The possibly null value for attribute iconKey.

setIconKey

public void setIconKey(String iconKey)

Sets a new value for the attribute iconKey.

Specified by:

setIconKey in interface QuickAccess

Parameters:

iconKey - The possibly null new value for attribute iconKey.

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:

QuickAccess.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:UserHomeContainsQuickAccess.

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 QuickAccess.Identity newIdentity(UserHome.Identity userHome,
                                               QualifierType idType,
                                               String id)

openmdxjdoToIdentity

public static QuickAccess.Identity openmdxjdoToIdentity(ObjectId objectId)