com.oberon.ooql.sdk
Class Stage

java.lang.Object
  com.oberon.ooql.sdk.OBBase
      com.oberon.ooql.sdk.AdminComponent
          com.oberon.ooql.sdk.Stage

All Implemented Interfaces:

java.io.Serializable

public class Stage
extends AdminComponent
implements java.io.Serializable

Represents a Lifecycle stage.

Version:

5.0

See Also:

Serialized Form

Field Summary

static int	ADD_TO_RECENT_LIST_OPTION The Add To Recent List flag index inside the Option Set
static int	AUTOPROGRESS_OPTION The AutoProgress flag index inside the Option Set
static int	AUTORESET_OPTION The AutoRest flag index inside the Option Set
static int	REVISIONABLE_OPTION The Revisionable flag index inside the Option Set

Fields inherited from class com.oberon.ooql.sdk.AdminComponent

bsOptions

Constructor Summary

Stage()

Stage(java.lang.String name)

Method Summary

void	addCommand(java.lang.String commandName) Add an application Command for ObjectObj instances with this Lifecycle-Stage.
void	addCommandAfter(java.lang.String commandName, java.lang.String refCommand) Add an application Command after another reference command
void	addCommandBefore(java.lang.String commandName, java.lang.String refCommand) Add an application Command before another reference command
void	addTrigger(Trigger trigger) Add a Trigger to this Stage;
void	addValidation(Validation validation) Add a Validation to this Stage
java.lang.String	compareUpdate(Stage refStage, boolean checkImage, Framework framework) Return the OOQL command to update this Lifecycle-Stage object and let it become equals to another reference object.
boolean	equals(Stage stage) Check if this Stage is equal to another
void	fromXML(org.jdom.Element rootElement) Load the Stage object from XML element tree
ActorAccess	getActorAccess(java.lang.String actorType, java.lang.String actorName) Get the ObjectObj accesses for a specific actor at this Stage
boolean	getActorAccess(java.lang.String actorType, java.lang.String actorName, int accessType) Get actor access at this Stage for a specific operation
java.lang.String	getActorAccessAsString(java.lang.String actorType, java.lang.String actorName, java.lang.String delim) Get the ObjectObj accesses for a specific actor at this Stage in OOQL format
java.util.Vector<ActorAccess>	getActorAccesses() Get the all actor accesses for this Stage
java.util.Vector<java.lang.String>	getActors() Get the list of all actors for this Stage
java.util.Vector<java.lang.String>	getActors(java.lang.String actorType) Get the list of actors for this Stage
java.lang.String	getApplication() Get the application Menu name.
java.lang.String	getChangeCommand() Return the OOQL command to update this Lifecycle-Stage with the settled properties
java.util.Vector<java.lang.String>	getCommands() Get the list of application Commands available for ObjectObj instances with this Lifecycle-Stage included the Lifecycle common commands
java.lang.String	getCommandsAsString(java.lang.String delim) Get the list of application Commands included the Lifecycle common Commands as a single String.
java.util.BitSet	getCommunityAccess() Get the ObjectObj accesses for the community at this Stage
boolean	getCommunityAccess(int accessType) Get the community access at this Stage for a specific operation
java.lang.String	getCommunityAccessAsString(java.lang.String delim) Get the ObjectObj accesses for the community at this Stage in OOQL format
java.lang.String	getCreateCommand(boolean force) [Inherited but not used]
java.lang.String	getCreateCommand(java.lang.String operator, java.lang.String stageName) Return the OOQL command to add this Stage with the settled properties to a Lifecycle
java.util.BitSet	getHistoryOption() Get the events traced into the history table for ObjectObjs with this Stage
boolean	getHistoryOption(int event) Check if a specific event is traced into the history table for ObjectObjs with this Stage
java.lang.String	getHistoryOptionsAsString(java.lang.String delim) Get the events traced into the history table for ObjectObjs with this Stage as String
java.util.BitSet	getHolderAccess() Get the ObjectObj accesses for the holder at this Stage
boolean	getHolderAccess(int accessType) Get the holder access at this Stage for a specific operation
java.lang.String	getHolderAccessAsString(java.lang.String delim) Get the ObjectObj accesses for the holder at this Stage in OOQL format
Lifecycle	getLifecycle() Get the related Lifecycle
java.util.Vector<java.lang.String>	getOwnCommands() Get the list of application Commands available for ObjectObj instances with this Lifecycle-Stage
java.lang.String	getOwnCommandsAsString(java.lang.String delim) Get the list of application Commands as a single String.
java.lang.String	getProperty(java.lang.String propertyName, java.util.Vector<java.lang.Object> filterArgs, java.lang.String token, Framework framework) Get a property for this Lifecycle-Stage object by its OOQL identifier
java.lang.String	getSaveCommand(boolean force) [Inherited but not used]
java.util.Vector<?>	getTargetNames(java.lang.String composedName, java.util.Vector<java.lang.Object> filterArgs, Framework framework) Return a Vector of administrative object names extracted by using an OOQL selector
Trigger	getTriggerByEvent(java.lang.String event) Get the Program-Trigger for a specific event
java.util.Vector<Trigger>	getTriggers() Return the list of Triggers defined for this Stage
java.lang.String	getTriggersAsString(java.lang.String delim) Return the list of Program-Triggers, as a String
Validation	getValidation(java.lang.String validationName) Get a Validation for this Stage
java.util.Vector<java.lang.String>	getValidationIDs() Get Validation internal ids for this Stage
java.util.Vector<java.lang.String>	getValidationNames() Get Validation names for this Stage
int	getValidationPos(Validation validation) Return the Validation position into the Stage-Validation list
java.util.Vector<Validation>	getValidations() Get Validations for this Stage
java.lang.String	getValidationsAsString(java.lang.String delim) Get Validation names for this Stage as String
java.lang.String	getWorkflowAsString(java.lang.String delim) Return the list of Workflow-Triggers, as a String
Trigger	getWorkflowByEvent(java.lang.String event) Get the Workflow-Trigger for a specific event
org.jdom.Element	getXMLAssignmentList(java.lang.String assignName) Return the Stage Assignment actor accesses as XML element tree
org.jdom.Element	getXMLCommunity() Return the Stage community accesses as XML element tree
org.jdom.Element	getXMLHistoryFlags() Return the history flags as XML element tree
org.jdom.Element	getXMLHolder() Return the Stage holder accesses as XML element tree
org.jdom.Element	getXMLTeamList(java.lang.String teamName) Return the Stage Team actor accesses as XML element tree
org.jdom.Element	getXMLUserList(java.lang.String userName) Return the Stage User actor accesses as XML element tree
boolean	hasAccess(int accessType, Framework framework) Check if the current framework User has access for a specific operation (ignore delegations and holder access)
boolean	hasAccess(int accessType, Framework framework, java.lang.String holderName) Deprecated.
boolean	hasAccess(int accessType, Framework framework, java.lang.String holderName, java.lang.String objectID) Deprecated.
boolean	hasAccess(int accessType, ObjectObj objectobj, Framework framework) Check if the current framework User has access for a specific operation on a given ObjectObj
boolean	hasAccess(int accessType, ObjectObj objectobj, java.lang.String userName, Framework framework) Check if a User has access for a specific operation on a given ObjectObj.
boolean	hasAccess(int accessType, java.lang.String userName, Framework framework) Check if a User has access for a specific operation (ignore delegations and holder access).
boolean	hasAccess(int accessType, java.lang.String userName, Framework framework, java.lang.String holderName) Deprecated.
boolean	hasAccess(int accessType, java.lang.String userName, Framework framework, java.lang.String holderName, java.lang.String objectID) Deprecated.
boolean	isAddToRecentList() Get the "add object to (user) recent list" option.
boolean	isAutoProgress() Check if the autoProgress option is active for this Stage
boolean	isAutoReset() Check if the autoReset option is active for this Stage
boolean	isHistoryActive(int event) Check if a specific event is traced into the history table for ObjectObjs with this Stage taking into account also the common settings in the Lifecycle
boolean	isImageChanged() Check if Stage image was updated
boolean	isRevisionable() Check if the revisionable option is active for this Stage
void	moveCommand(java.lang.String commandName, boolean after) Move an application Command for ObjectObj instances with this Lifecycle-Stage.
void	removeActorAccess(java.lang.String actorType, java.lang.String actorName) Revoke the ObjectObj access to a specific actor at this Stage
void	removeCommand(java.lang.String commandName) Remove an application Command for ObjectObj instances with this Lifecycle-Stage.
void	removeTrigger(Trigger trigger) Remove a Trigger from this Stage
void	removeValidation(Validation validation) Remove a Validation from this Stage
void	setActorAccess(java.lang.String actorType, java.lang.String actorName, java.util.BitSet accessFlags) Set the ObjectObj accesses for a specific actor at this Stage
void	setActorAccess(java.lang.String actorType, java.lang.String actorName, int accessType, boolean accessFlag) Set the ObjectObj access for an actor user at this Stage
void	setAddToRecentList(boolean addObject) Set the "add object to (user) recent list" option.
void	setAllActorAccess(java.lang.String actorType, java.lang.String actorName) Give the full ObjectObj access to a specific actor at this Stage
void	setAllCommunityAccess() Give the full ObjectObj access to the community at this Stage
void	setAllHistoryOption() Active all events history trace for ObjectObjs with this Stage
void	setAllHolderAccess() Give the full ObjectObj access to the holder at this Stage
void	setAutoProgress(boolean autoProgress) Set the autoProgress option.
void	setAutoReset(boolean autoReset) Set the autoReset option.
void	setCommunityAccess(java.util.BitSet accessFlags) Set the ObjectObj accesses for the community at this Stage
void	setCommunityAccess(int accessType, boolean accessFlag) Set the ObjectObj access for the community at this Stage
void	setHistoryOption(java.util.BitSet eventFlags) Set the events to log into the history table for ObjectObjs with this Stage
void	setHistoryOption(int event, boolean flag) Set the events to log into the history table for ObjectObjs with this Stage
void	setHolderAccess(java.util.BitSet accessFlags) Set the ObjectObj accesses for the holder at this Stage
void	setHolderAccess(int accessType, boolean accessFlag) Set the ObjectObj access for the ObjectObj's holder at this Stage
void	setLifeCycle(Lifecycle lifecycle) Link the Stage with the related Lifecycle
void	setNoCommunityAccess() Revoke the ObjectObj access to the community at this Stage
void	setNoHistoryOption() Disable history trace for ObjectObjs with this Stage
void	setNoHolderAccess() Revoke the ObjectObj access to the holder at this Stage
void	setOwnCommands(java.util.Vector<java.lang.String> commands) Set application Commands for ObjectObj instances with this Lifecycle-Stage.
void	setRevisionable(boolean revisionable) Set the revisionable option.
void	setTriggers(java.util.Vector<Trigger> triggers) Set Triggers for this Stage
void	setValidations(java.util.Vector<Validation> validations) Set Validations for this Stage
java.lang.String	toString() Return the Stage object basic properties as a single String
org.jdom.Element	toXML(boolean getImage, boolean fullDump, Framework framework) Return the Stage properties as XML element tree
org.jdom.Element	toXML(Framework framework) Return the Stage properties as XML element tree
void	updateActorAccess(java.util.Vector<ActorAccess> accesses) Update the execute access on the basis of a given list
void	updateCommands(java.util.Vector<java.lang.String> commands) Update the commands on the basis of a given list
void	updateTriggers(java.util.Vector<Trigger> triggers) Update the triggers on the basis of a given list
void	updateValidations(java.util.Vector<Validation> validations) Update the validations on the basis of a given list

Methods inherited from class com.oberon.ooql.sdk.AdminComponent

checkChangeName, getAdminType, getCommonProperty, getCommonTargetNames, getCrtDate, getDescription, getEditBasicCommand, getImage, getImageData, getImageFile, getModDate, getModUser, getName, getOldName, hasImage, setCrtDate, setDescription, setImage, setImageData, setImageFile, setModDate, setModUser, setName, toCommonXML, toXML

Methods inherited from class com.oberon.ooql.sdk.OBBase

addChange, addUniqueChange, ChangesFromXML, ChangesToXML, getChanges, getChangesAsString, getId, isLinked, removeChange, resetChanges, setId, setLinked

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

AUTOPROGRESS_OPTION

public static final int AUTOPROGRESS_OPTION

The AutoProgress flag index inside the Option Set

See Also:

Constant Field Values

REVISIONABLE_OPTION

public static final int REVISIONABLE_OPTION

The Revisionable flag index inside the Option Set

See Also:

Constant Field Values

AUTORESET_OPTION

public static final int AUTORESET_OPTION

The AutoRest flag index inside the Option Set

See Also:

Constant Field Values

ADD_TO_RECENT_LIST_OPTION

public static final int ADD_TO_RECENT_LIST_OPTION

The Add To Recent List flag index inside the Option Set

See Also:

Constant Field Values

Constructor Detail

Stage

public Stage()

Stage

public Stage(java.lang.String name)
      throws OberonException

Parameters:

name - the name of the administrative object

Throws:

OberonException - if the name contains invalid characters

Method Detail

isImageChanged

public boolean isImageChanged()

Check if Stage image was updated

setLifeCycle

public void setLifeCycle(Lifecycle lifecycle)

Link the Stage with the related Lifecycle

getLifecycle

public Lifecycle getLifecycle()

Get the related Lifecycle

getApplication

public java.lang.String getApplication()

Get the application Menu name.

Since:

2.2_01

setAutoProgress

public void setAutoProgress(boolean autoProgress)

Set the autoProgress option. When autoprogress is true the ObjectObj status is automatically forwarded to the fork Stage as soon as all validations are satisfied

isAutoProgress

public boolean isAutoProgress()

Check if the autoProgress option is active for this Stage

setAutoReset

public void setAutoReset(boolean autoReset)

Set the autoReset option. When autoreset is true all validations are automatically resetted when ObjectObj reaches this stage

isAutoReset

public boolean isAutoReset()

Check if the autoReset option is active for this Stage

setRevisionable

public void setRevisionable(boolean revisionable)

Set the revisionable option. An ObjectObj at this Stage can be revised only if this flag is true

isRevisionable

public boolean isRevisionable()

Check if the revisionable option is active for this Stage

setAddToRecentList

public void setAddToRecentList(boolean addObject)

Set the "add object to (user) recent list" option. The ObjectObjs in this stage will be added to the user recent opened list if this flag is true

Since:

2.3.05

isAddToRecentList

public boolean isAddToRecentList()

Get the "add object to (user) recent list" option.

Since:

2.3.05

setHistoryOption

public void setHistoryOption(int event,
                             boolean flag)

Set the events to log into the history table for ObjectObjs with this Stage

Parameters:

event - the history event

flag - if true the event will be traced into the history

setAllHistoryOption

public void setAllHistoryOption()

Active all events history trace for ObjectObjs with this Stage

setNoHistoryOption

public void setNoHistoryOption()

Disable history trace for ObjectObjs with this Stage

setHistoryOption

public void setHistoryOption(java.util.BitSet eventFlags)

Set the events to log into the history table for ObjectObjs with this Stage

getHistoryOption

public boolean getHistoryOption(int event)

Check if a specific event is traced into the history table for ObjectObjs with this Stage

Parameters:

event - the event code

isHistoryActive

public boolean isHistoryActive(int event)

Check if a specific event is traced into the history table for ObjectObjs with this Stage taking into account also the common settings in the Lifecycle

Parameters:

event - the event code

Since:

3.0

getHistoryOption

public java.util.BitSet getHistoryOption()

Get the events traced into the history table for ObjectObjs with this Stage

getHistoryOptionsAsString

public java.lang.String getHistoryOptionsAsString(java.lang.String delim)

Get the events traced into the history table for ObjectObjs with this Stage as String

Parameters:

delim - the event name separator

setHolderAccess

public void setHolderAccess(int accessType,
                            boolean accessFlag)

Set the ObjectObj access for the ObjectObj's holder at this Stage

Parameters:

accessType - the access type

accessFlag - true to enable / false to disable the access

setAllHolderAccess

public void setAllHolderAccess()

Give the full ObjectObj access to the holder at this Stage

setNoHolderAccess

public void setNoHolderAccess()

Revoke the ObjectObj access to the holder at this Stage

setHolderAccess

public void setHolderAccess(java.util.BitSet accessFlags)

Set the ObjectObj accesses for the holder at this Stage

getHolderAccess

public boolean getHolderAccess(int accessType)

Get the holder access at this Stage for a specific operation

Parameters:

accessType - the access type

getHolderAccess

public java.util.BitSet getHolderAccess()

Get the ObjectObj accesses for the holder at this Stage

getHolderAccessAsString

public java.lang.String getHolderAccessAsString(java.lang.String delim)

Get the ObjectObj accesses for the holder at this Stage in OOQL format

Parameters:

delim - the access separator string

Since:

4.0

setCommunityAccess

public void setCommunityAccess(int accessType,
                               boolean accessFlag)

Set the ObjectObj access for the community at this Stage

Parameters:

accessType - the access type

accessFlag - true to enable / false to disable the access

setAllCommunityAccess

public void setAllCommunityAccess()

Give the full ObjectObj access to the community at this Stage

setNoCommunityAccess

public void setNoCommunityAccess()

Revoke the ObjectObj access to the community at this Stage

setCommunityAccess

public void setCommunityAccess(java.util.BitSet accessFlags)

Set the ObjectObj accesses for the community at this Stage

getCommunityAccess

public boolean getCommunityAccess(int accessType)

Get the community access at this Stage for a specific operation

Parameters:

accessType - the access type

getCommunityAccess

public java.util.BitSet getCommunityAccess()

Get the ObjectObj accesses for the community at this Stage

getCommunityAccessAsString

public java.lang.String getCommunityAccessAsString(java.lang.String delim)

Get the ObjectObj accesses for the community at this Stage in OOQL format

Parameters:

delim - the access separator string

Since:

4.0

setActorAccess

public void setActorAccess(java.lang.String actorType,
                           java.lang.String actorName,
                           java.util.BitSet accessFlags)

Set the ObjectObj accesses for a specific actor at this Stage

Parameters:

actorType - the actor type: can be ActorAccess.USER , ActorAccess.TEAM , ActorAccess.ASSIGNMENT

actorName - the actor name

setActorAccess

public void setActorAccess(java.lang.String actorType,
                           java.lang.String actorName,
                           int accessType,
                           boolean accessFlag)

Set the ObjectObj access for an actor user at this Stage

Parameters:

actorType - the actor type: can be ActorAccess.USER , ActorAccess.TEAM , ActorAccess.ASSIGNMENT

actorName - the actor name

accessType - the access type

accessFlag - true to enable / false to disable the access

setAllActorAccess

public void setAllActorAccess(java.lang.String actorType,
                              java.lang.String actorName)

Give the full ObjectObj access to a specific actor at this Stage

Parameters:

actorType - the actor type: can be ActorAccess.USER , ActorAccess.TEAM , ActorAccess.ASSIGNMENT

actorName - the actor name

removeActorAccess

public void removeActorAccess(java.lang.String actorType,
                              java.lang.String actorName)

Revoke the ObjectObj access to a specific actor at this Stage

Parameters:

actorType - the actor type: can be ActorAccess.USER , ActorAccess.TEAM , ActorAccess.ASSIGNMENT

actorName - the actor name

updateActorAccess

public void updateActorAccess(java.util.Vector<ActorAccess> accesses)

Update the execute access on the basis of a given list

Parameters:

accesses - list of ActorAccesses

Since:

4.0

getActorAccess

public boolean getActorAccess(java.lang.String actorType,
                              java.lang.String actorName,
                              int accessType)

Get actor access at this Stage for a specific operation

Parameters:

actorType - the actor type: can be ActorAccess.USER , ActorAccess.TEAM , ActorAccess.ASSIGNMENT

actorName - the actor name

accessType - the access type

getActorAccess

public ActorAccess getActorAccess(java.lang.String actorType,
                                  java.lang.String actorName)

Get the ObjectObj accesses for a specific actor at this Stage

Parameters:

actorType - the actor type: can be ActorAccess.USER , ActorAccess.TEAM , ActorAccess.ASSIGNMENT

actorName - the actor name

getActors

public java.util.Vector<java.lang.String> getActors(java.lang.String actorType)

Get the list of actors for this Stage

Parameters:

actorType - the actor type: can be ActorAccess.USER , ActorAccess.TEAM , ActorAccess.ASSIGNMENT or empty

Returns:

a vector of couple actorType|actorName

getActors

public java.util.Vector<java.lang.String> getActors()

Get the list of all actors for this Stage

Returns:

a vector of couple actorType|actorName

getActorAccesses

public java.util.Vector<ActorAccess> getActorAccesses()

Get the all actor accesses for this Stage

Returns:

a vector of ActorAccesses

Since:

4.0

getActorAccessAsString

public java.lang.String getActorAccessAsString(java.lang.String actorType,
                                               java.lang.String actorName,
                                               java.lang.String delim)

Get the ObjectObj accesses for a specific actor at this Stage in OOQL format

Parameters:

actorType - the actor type: can be ActorAccess.USER , ActorAccess.TEAM , ActorAccess.ASSIGNMENT

actorName - the actor name

delim - the access separator string

Since:

4.0

setTriggers

public void setTriggers(java.util.Vector<Trigger> triggers)

Set Triggers for this Stage

Parameters:

triggers - a vector of Triggers

See Also:

Trigger

addTrigger

public void addTrigger(Trigger trigger)
                throws OberonException

Add a Trigger to this Stage;

Parameters:

trigger - the Trigger to add

Throws:

OberonException

removeTrigger

public void removeTrigger(Trigger trigger)

Remove a Trigger from this Stage

Parameters:

trigger - the Trigger to remove

updateTriggers

public void updateTriggers(java.util.Vector<Trigger> triggers)
                    throws OberonException

Update the triggers on the basis of a given list

Parameters:

triggers - list of Triggers

Throws:

OberonException

Since:

4.0

getTriggers

public java.util.Vector<Trigger> getTriggers()

Return the list of Triggers defined for this Stage

Returns:

Vector of Triggers

getTriggersAsString

public java.lang.String getTriggersAsString(java.lang.String delim)

Return the list of Program-Triggers, as a String

Parameters:

delim - the separator item

Returns:

list of Triggers separated by the delim characters

See Also:

Trigger.asString()

getWorkflowAsString

public java.lang.String getWorkflowAsString(java.lang.String delim)

Return the list of Workflow-Triggers, as a String

Parameters:

delim - the separator item

Returns:

list of Triggers separated by the delim characters

Since:

2.1

See Also:

Trigger.asString()

getTriggerByEvent

public Trigger getTriggerByEvent(java.lang.String event)

Get the Program-Trigger for a specific event

Parameters:

event - the event name as defined by the OOQL syntax ( example: edit.check )

Returns:

the event Trigger or null if the event is not associated to a Trigger

getWorkflowByEvent

public Trigger getWorkflowByEvent(java.lang.String event)

Get the Workflow-Trigger for a specific event

Parameters:

event - the event name as defined by the OOQL syntax ( example: edit )

Returns:

the event Trigger or null if the event is not associated to a Trigger

Since:

2.1

addCommand

public void addCommand(java.lang.String commandName)

Add an application Command for ObjectObj instances with this Lifecycle-Stage.

addCommandBefore

public void addCommandBefore(java.lang.String commandName,
                             java.lang.String refCommand)
                      throws OberonException

Add an application Command before another reference command

Parameters:

commandName - the Command name

refCommand - the reference Command name

Throws:

OberonException - when the reference Command is not found

addCommandAfter

public void addCommandAfter(java.lang.String commandName,
                            java.lang.String refCommand)
                     throws OberonException

Add an application Command after another reference command

Parameters:

commandName - the Command name

refCommand - the reference Command name

Throws:

OberonException - when the reference Command is not found

removeCommand

public void removeCommand(java.lang.String commandName)

Remove an application Command for ObjectObj instances with this Lifecycle-Stage.

moveCommand

public void moveCommand(java.lang.String commandName,
                        boolean after)

Move an application Command for ObjectObj instances with this Lifecycle-Stage.

Parameters:

commandName - the Command name

after - if true move the Command after else move it before the current position

updateCommands

public void updateCommands(java.util.Vector<java.lang.String> commands)

Update the commands on the basis of a given list

Parameters:

commands - list of Commands

Since:

4.0

setOwnCommands

public void setOwnCommands(java.util.Vector<java.lang.String> commands)

Set application Commands for ObjectObj instances with this Lifecycle-Stage.

Parameters:

commands - vector of Command names

getOwnCommands

public java.util.Vector<java.lang.String> getOwnCommands()

Get the list of application Commands available for ObjectObj instances with this Lifecycle-Stage

Returns:

vector of Command names

getOwnCommandsAsString

public java.lang.String getOwnCommandsAsString(java.lang.String delim)

Get the list of application Commands as a single String.

Parameters:

delim - the Command name separator

See Also:

getCommands()

getCommands

public java.util.Vector<java.lang.String> getCommands()

Get the list of application Commands available for ObjectObj instances with this Lifecycle-Stage included the Lifecycle common commands

Returns:

vector of Command names

getCommandsAsString

public java.lang.String getCommandsAsString(java.lang.String delim)

Get the list of application Commands included the Lifecycle common Commands as a single String.

Parameters:

delim - the Command name separator

See Also:

getCommands()

addValidation

public void addValidation(Validation validation)

Add a Validation to this Stage

removeValidation

public void removeValidation(Validation validation)

Remove a Validation from this Stage

setValidations

public void setValidations(java.util.Vector<Validation> validations)

Set Validations for this Stage

Parameters:

validations - vector of Validations

updateValidations

public void updateValidations(java.util.Vector<Validation> validations)
                       throws OberonException

Update the validations on the basis of a given list

Parameters:

validations - list of Validations

Throws:

OberonException

Since:

4.0

getValidations

public java.util.Vector<Validation> getValidations()

Get Validations for this Stage

Returns:

vector of Validations

getValidation

public Validation getValidation(java.lang.String validationName)

Get a Validation for this Stage

Parameters:

validationName - the Validation name

Returns:

null if the Validation is not defined

getValidationNames

public java.util.Vector<java.lang.String> getValidationNames()

Get Validation names for this Stage

Returns:

vector of Validation names

getValidationIDs

public java.util.Vector<java.lang.String> getValidationIDs()

Get Validation internal ids for this Stage

Returns:

vector of Validation ids

getValidationsAsString

public java.lang.String getValidationsAsString(java.lang.String delim)

Get Validation names for this Stage as String

Parameters:

delim - the name separator

getValidationPos

public int getValidationPos(Validation validation)

Return the Validation position into the Stage-Validation list

equals

public boolean equals(Stage stage)

Check if this Stage is equal to another

Parameters:

stage - the Stage to compare with this Stage

hasAccess

public boolean hasAccess(int accessType,
                         ObjectObj objectobj,
                         Framework framework)

Check if the current framework User has access for a specific operation on a given ObjectObj

Parameters:

accessType - the access Type

objectobj - the specific ObjectObj

framework - the current framework

See Also:

hasAccess(int, ObjectObj, String, Framework)

hasAccess

public boolean hasAccess(int accessType,
                         ObjectObj objectobj,
                         java.lang.String userName,
                         Framework framework)

Check if a User has access for a specific operation on a given ObjectObj.
The general checks are:
- check if the user is a Super User (in this case return true)
- check if User has global access to the operation (otherwise return false)
- check the community access
- check if the User has direct access as actor access
- check if the User belong to a Team enabled to perform the operation
- check if the User has at least one Assignment enabled to perform the operation
The object specific checks are:
- check the holder access if the user is the ObjectObj's holder / alt-holder
- check if the User has valid ObjectDelegation(s) to perform the operation

Parameters:

accessType - the access Type

objectobj - the specific ObjectObj

userName - the name of User to check

framework - the current framework

hasAccess

@Deprecated
public boolean hasAccess(int accessType,
                                    Framework framework,
                                    java.lang.String holderName,
                                    java.lang.String objectID)

Deprecated.

Check if the current framework User has access for a specific operation on a specific ObjectObj

Parameters:

accessType - the access Type

framework - the current framework

holderName - the ObjectObj's holder name

objectID - the ObjectObj's ID

See Also:

hasAccess(int, String, Framework, String, String)

hasAccess

@Deprecated
public boolean hasAccess(int accessType,
                                    java.lang.String userName,
                                    Framework framework,
                                    java.lang.String holderName,
                                    java.lang.String objectID)

Deprecated.

Check if a User has access for a specific operation on a specific ObjectObj.
The check steps are:
- check if the user is a Super User (in this case return true)
- check if User has global access to the operation (otherwise return false)
- check the community access
- check the holder access if he is the ObjectObj's holder
- check if the User has direct access as actor access
- check if the User belong to a Team enabled to perform the operation
- check if the User has at least one Assignment enabled to perform the operation
- check if the User has valid ObjectDelegation(s) to perform the operation

Parameters:

accessType - the access Type

framework - the current framework

userName - the User name

holderName - the ObjectObj's holder name

objectID - the ObjectObj's ID

hasAccess

@Deprecated
public boolean hasAccess(int accessType,
                                    Framework framework,
                                    java.lang.String holderName)

Deprecated.

Check if the current framework User has access for a specific operation (ignore delegations)

Parameters:

accessType - the access Type

framework - the current framework

holderName - the ObjectObj's holder name

See Also:

hasAccess(int, String, Framework, String)

hasAccess

@Deprecated
public boolean hasAccess(int accessType,
                                    java.lang.String userName,
                                    Framework framework,
                                    java.lang.String holderName)

Deprecated.

Check if a User has access for a specific operation (ignore delegations).
The check steps are:
- check if the User is a Super User (in this case return true)
- check if User has global access to the operation (otherwise return false)
- check the community access
- check the holder access if he is the holder
- check if the User has direct access as actor access
- check if the User belong to a Team enabled to perform the operation
- check if the User has at least one Assignment enabled to perform the operation

Parameters:

accessType - the access Type

userName - the User name

framework - the current framework

holderName - the ObjectObj's holder name

See Also:

hasAccess(int, String, Framework, String)

hasAccess

public boolean hasAccess(int accessType,
                         Framework framework)

Check if the current framework User has access for a specific operation (ignore delegations and holder access)

Parameters:

accessType - the access Type

framework - the current framework

See Also:

hasAccess(int, String, Framework)

hasAccess

public boolean hasAccess(int accessType,
                         java.lang.String userName,
                         Framework framework)

Check if a User has access for a specific operation (ignore delegations and holder access).
The check steps are:
- check if the User is a Super User (in this case return true)
- check if User has global access to the operation (otherwise return false)
- check the community access
- check if the User has direct access as actor access
- check if the User belong to a Team enabled to perform the operation
- check if the User has at least one Assignment enabled to perform the operation

Parameters:

accessType - the access Type

userName - the User name

framework - the current framework

See Also:

hasAccess(int, String, Framework, String)

getProperty

public java.lang.String getProperty(java.lang.String propertyName,
                                    java.util.Vector<java.lang.Object> filterArgs,
                                    java.lang.String token,
                                    Framework framework)

Get a property for this Lifecycle-Stage object by its OOQL identifier

Specified by:

getProperty in class OBBase

Parameters:

propertyName - OOQL property identifier/name (example: autoprogress , community ...)

filterArgs - extra arguments used to compute properties

token - separator token for complex properties

framework - the current framework

Returns:

the property value

getTargetNames

public java.util.Vector<?> getTargetNames(java.lang.String composedName,
                                          java.util.Vector<java.lang.Object> filterArgs,
                                          Framework framework)

Return a Vector of administrative object names extracted by using an OOQL selector

Specified by:

getTargetNames in class OBBase

Parameters:

composedName - OOQL property identifier/name (example: validation, owncommand, .. )

filterArgs - extra arguments used to compute properties

framework - the current framework

Returns:

a Vector of target names, used to extract their (sub)properties values

toString

public java.lang.String toString()

Return the Stage object basic properties as a single String

Overrides:

toString in class java.lang.Object

getXMLHolder

public org.jdom.Element getXMLHolder()

Return the Stage holder accesses as XML element tree

getXMLCommunity

public org.jdom.Element getXMLCommunity()

Return the Stage community accesses as XML element tree

getXMLUserList

public org.jdom.Element getXMLUserList(java.lang.String userName)

Return the Stage User actor accesses as XML element tree

Parameters:

userName - the User name (empty for all Users)

getXMLTeamList

public org.jdom.Element getXMLTeamList(java.lang.String teamName)

Return the Stage Team actor accesses as XML element tree

Parameters:

teamName - the Team name (empty for all Teams)

getXMLAssignmentList

public org.jdom.Element getXMLAssignmentList(java.lang.String assignName)

Return the Stage Assignment actor accesses as XML element tree

Parameters:

assignName - the Assignment name (empty for all Assignments)

getXMLHistoryFlags

public org.jdom.Element getXMLHistoryFlags()

Return the history flags as XML element tree

toXML

public org.jdom.Element toXML(Framework framework)

Return the Stage properties as XML element tree

Parameters:

framework - the current framework

toXML

public org.jdom.Element toXML(boolean getImage,
                              boolean fullDump,
                              Framework framework)

Return the Stage properties as XML element tree

Parameters:

fullDump - true to include detailed information

framework - the current framework

fromXML

public void fromXML(org.jdom.Element rootElement)

Load the Stage object from XML element tree

Overrides:

fromXML in class AdminComponent

getCreateCommand

public java.lang.String getCreateCommand(boolean force)

[Inherited but not used]

getSaveCommand

public java.lang.String getSaveCommand(boolean force)

[Inherited but not used]

getCreateCommand

public java.lang.String getCreateCommand(java.lang.String operator,
                                         java.lang.String stageName)

Return the OOQL command to add this Stage with the settled properties to a Lifecycle

Parameters:

operator - OOQL syntax position (example: "append" , "addbefore" ....)

stageName - the name of the reference Stage

getChangeCommand

public java.lang.String getChangeCommand()

Return the OOQL command to update this Lifecycle-Stage with the settled properties

compareUpdate

public java.lang.String compareUpdate(Stage refStage,
                                      boolean checkImage,
                                      Framework framework)
                               throws OberonException

Return the OOQL command to update this Lifecycle-Stage object and let it become equals to another reference object.
This method is useful to import objects from an XML file.

Parameters:

refStage - the reference Stage object

framework - the current framework

Throws:

OberonException

See Also:

fromXML(Element)