no.g9.jgrape

Class Role

java.lang.Object

no.g9.jgrape.Role

All Implemented Interfaces:

Manager

public abstract class Role
extends Object
implements Manager

This is the common superclass to all object selection role managers. An object selection role manager represent one role node in the object selection.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Role.Key The Key class holds information for one unique key.

Constructor Summary

Constructors

Constructor and Description
Role() Default constructor.

Method Summary

Modifier and Type	Method and Description
protected Role.Key	addKey(String keyName, boolean inOs, boolean isPrimaryKey) Add a new unique key to this role managers List of keys.
void	cleanupResult(Object rootResult) Deprecated.
void	cleanupResult(Object rootResult, ClientContext ctx) Deprecated.
void	cleanupResult(Object rootResult, ClientContext ctx, Session session) Postprocess the result after transaction is ended
void	cleanupResultAssociations(Object rootResult, ClientContext ctx, Session session) Postprocess the result after find actions
abstract Object	connect(ObjectSelection objectSelection, ClientContext ctx, Session session) Part of the Manager interface.
abstract Object	delete(ObjectSelection objectSelection, ClientContext ctx, Session session) Part of the Manager interface.
abstract Object	disconnect(ObjectSelection objectSelection, ClientContext ctx, Session session) Part of the Manager interface.
abstract Object	find(ObjectSelection objectSelection, ClientContext ctx, Session session) Part of the Manager interface.
abstract List<?>	findAll(ObjectSelection objectSelection, ClientContext ctx, Session session) Part of the Manager interface.
Role	findRole(String roleName) Find an object selection role manager given name.
abstract Object	get(ObjectSelection objectSelection, ENavigation navigation, ClientContext ctx, Session session) Part of the Manager interface.
ObjectSelection	getCurrentObjectSelection() Access method for the currentObjectSelection property.
protected List<Role>	getDownRelated() Access method for the downRelated property.
protected List<String>	getExcludedAttributes() Access method for the excludedAttributes property.
protected List<String>	getIncludedAttributes() Access method for the includedAttributes property.
protected List<String>	getKeyAttributes(String keyName) Get list of attribute names for a unique key
protected String	getMainKey() Get the name of main key if this object selection role has a main key.
protected String	getName() Access method for the name property.
protected Role	getParent() Access method for the parent property.
protected String	getPrimaryKey() Get the name of primary key if the object selection role has a primary key and all attributes in that key are included in the object selection.
protected Role	getRootRole() Get the root object selection role manager.
protected List<Role>	getUpRelated() Access method for the upRelated property.
void	initializeRole(String applicationName, String roleName, Role parentRole) Initialize an object selection role manager.
abstract Object	insert(ObjectSelection objectSelection, ClientContext ctx, Session session) Part of the Manager interface.
abstract Object	save(ObjectSelection objectSelection, ClientContext ctx, Session session) Part of the Manager interface.
void	setCurrentObjectSelection(ObjectSelection anObjectSelection) Sets the value of the currentObjectSelection property.
protected void	setDownRelated(List<Role> aDownRelated) Sets the value of the downRelated property.
protected void	setExcludedAttributes(List<String> aExcludedAttributes) Sets the value of the excludedAttributes property.
protected void	setIncludedAttributes(List<String> aIncludedAttributes) Sets the value of the includedAttributes property.
protected void	setName(String aName) Sets the value of the name property.
protected void	setParent(Role aParent) Sets the value of the parent property.
protected void	setUpRelated(List<Role> aUpRelated) Sets the value of the upRelated property manager.
abstract Object	update(ObjectSelection objectSelection, ClientContext ctx, Session session) Part of the Manager interface.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Role

public Role()

Default constructor.

Method Detail

addKey

protected Role.Key addKey(String keyName,
                          boolean inOs,
                          boolean isPrimaryKey)

Add a new unique key to this role managers List of keys.

Parameters:

keyName - the name of the key

inOs - the inOs property

isPrimaryKey - the isPrimaryKey property

Returns:

the new unique key

getKeyAttributes

protected List<String> getKeyAttributes(String keyName)

Get list of attribute names for a unique key

Parameters:

keyName - is the name of the key

Returns:

The list of attribute names. Returns null if keyName is unknown

getPrimaryKey

protected String getPrimaryKey()

Get the name of primary key if the object selection role has a primary key and all attributes in that key are included in the object selection.

Returns:

Either Name of primary key or null if not all attributes are included in the object selection.

getMainKey

protected String getMainKey()

Get the name of main key if this object selection role has a main key. A main key is the first unique key where all attributes are included in the object selection.

Returns:

Name of main key

getName

protected String getName()

Access method for the name property.

Returns:

The current value of the name property

setName

protected void setName(String aName)

Sets the value of the name property.

Parameters:

aName - the new value of the name property

getExcludedAttributes

protected List<String> getExcludedAttributes()

Access method for the excludedAttributes property.

Returns:

the current value of the excludedAttributes property

setExcludedAttributes

protected void setExcludedAttributes(List<String> aExcludedAttributes)

Sets the value of the excludedAttributes property.

Parameters:

aExcludedAttributes - the new value of the excludedAttributes property

getIncludedAttributes

protected List<String> getIncludedAttributes()

Access method for the includedAttributes property.

Returns:

the current value of the includedAttributes property

setIncludedAttributes

protected void setIncludedAttributes(List<String> aIncludedAttributes)

Sets the value of the includedAttributes property.

Parameters:

aIncludedAttributes - the new value of the includedAttributes property

getDownRelated

protected List<Role> getDownRelated()

Access method for the downRelated property.

Returns:

the current value of the downRelated property

setDownRelated

protected void setDownRelated(List<Role> aDownRelated)

Sets the value of the downRelated property.

Parameters:

aDownRelated - the new value of the downRelated property

getUpRelated

protected List<Role> getUpRelated()

Access method for the upRelated property.

Returns:

the current value of the upRelated property

setUpRelated

protected void setUpRelated(List<Role> aUpRelated)

Sets the value of the upRelated property manager.

Parameters:

aUpRelated - the new value of the upRelated property

getCurrentObjectSelection

public ObjectSelection getCurrentObjectSelection()

Access method for the currentObjectSelection property.

Returns:

the current value of the currentObjectSelection property

setCurrentObjectSelection

public void setCurrentObjectSelection(ObjectSelection anObjectSelection)

Sets the value of the currentObjectSelection property.

Parameters:

anObjectSelection - the new value of the currentObjectSelection property

getParent

protected Role getParent()

Access method for the parent property.

Returns:

the current value of the parent property

setParent

protected void setParent(Role aParent)

Sets the value of the parent property.

Parameters:

aParent - the new value of the parent property

initializeRole

public void initializeRole(String applicationName,
                           String roleName,
                           Role parentRole)

Initialize an object selection role manager.

Parameters:

applicationName - Name of the application

roleName - Name of the role

parentRole - Parent role to this role in the object selection

findRole

public Role findRole(String roleName)

Find an object selection role manager given name.

Parameters:

roleName - the name of the object selection role.

Returns:

no.g9.service.Role

find

public abstract Object find(ObjectSelection objectSelection,
                            ClientContext ctx,
                            Session session)

Part of the Manager interface.

Specified by:

find in interface Manager

Parameters:

objectSelection - (missing javadoc)

ctx - (missing javadoc)

session - (missing javadoc)

Returns:

(missing javadoc)

findAll

public abstract List<?> findAll(ObjectSelection objectSelection,
                                ClientContext ctx,
                                Session session)

Part of the Manager interface.

Specified by:

findAll in interface Manager

Parameters:

objectSelection - (missing javadoc)

ctx - (missing javadoc)

session - (missing javadoc)

Returns:

(missing javadoc)

save

public abstract Object save(ObjectSelection objectSelection,
                            ClientContext ctx,
                            Session session)

Part of the Manager interface.

Specified by:

save in interface Manager

Parameters:

objectSelection - (missing javadoc)

ctx - (missing javadoc)

session - (missing javadoc)

Returns:

(missing javadoc)

insert

public abstract Object insert(ObjectSelection objectSelection,
                              ClientContext ctx,
                              Session session)

Part of the Manager interface.

Specified by:

insert in interface Manager

Parameters:

objectSelection - (missing javadoc)

ctx - (missing javadoc)

session - (missing javadoc)

Returns:

(missing javadoc)

update

public abstract Object update(ObjectSelection objectSelection,
                              ClientContext ctx,
                              Session session)

Part of the Manager interface.

Specified by:

update in interface Manager

Parameters:

objectSelection - (missing javadoc)

ctx - (missing javadoc)

session - (missing javadoc)

Returns:

(missing javadoc)

delete

public abstract Object delete(ObjectSelection objectSelection,
                              ClientContext ctx,
                              Session session)

Part of the Manager interface.

Specified by:

delete in interface Manager

Parameters:

objectSelection - (missing javadoc)

ctx - (missing javadoc)

session - (missing javadoc)

Returns:

(missing javadoc)

connect

public abstract Object connect(ObjectSelection objectSelection,
                               ClientContext ctx,
                               Session session)

Part of the Manager interface.

Specified by:

connect in interface Manager

Parameters:

objectSelection - (missing javadoc)

ctx - (missing javadoc)

session - (missing javadoc)

Returns:

(missing javadoc)

disconnect

public abstract Object disconnect(ObjectSelection objectSelection,
                                  ClientContext ctx,
                                  Session session)

Part of the Manager interface.

Specified by:

disconnect in interface Manager

Parameters:

objectSelection - (missing javadoc)

ctx - (missing javadoc)

session - (missing javadoc)

Returns:

(missing javadoc)

get

public abstract Object get(ObjectSelection objectSelection,
                           ENavigation navigation,
                           ClientContext ctx,
                           Session session)

Part of the Manager interface.

Specified by:

get in interface Manager

Parameters:

objectSelection - (missing javadoc)

navigation - (missing javadoc)

ctx - (missing javadoc)

session - (missing javadoc)

Returns:

(missing javadoc)

cleanupResult

@Deprecated
public void cleanupResult(Object rootResult)

Deprecated.

Description copied from interface: Manager

Postprocess the result after transaction is ended

Specified by:

cleanupResult in interface Manager

Parameters:

rootResult - (missing javadoc) This method is replaced with cleanupResult(Object rootResult, ClientContext ctx) It is included in the interface for compatibility reasons

cleanupResult

@Deprecated
public void cleanupResult(Object rootResult,
                                      ClientContext ctx)

Deprecated.

Description copied from interface: Manager

Postprocess the result after transaction is ended

Specified by:

cleanupResult in interface Manager

Parameters:

rootResult - (missing javadoc)

ctx - (missing javadoc)

cleanupResult

public void cleanupResult(Object rootResult,
                          ClientContext ctx,
                          Session session)

Description copied from interface: Manager

Postprocess the result after transaction is ended

Specified by:

cleanupResult in interface Manager

Parameters:

rootResult - (missing javadoc)

ctx - (missing javadoc)

session - (missing javadoc)

cleanupResultAssociations

public void cleanupResultAssociations(Object rootResult,
                                      ClientContext ctx,
                                      Session session)

Description copied from interface: Manager

Postprocess the result after find actions

Specified by:

cleanupResultAssociations in interface Manager

Parameters:

rootResult - (missing javadoc)

ctx - (missing javadoc)

session - (missing javadoc)

getRootRole

protected Role getRootRole()

Get the root object selection role manager.

Returns:

(missing javadoc)