com.oberon.ooql.sdk
Class ObjectValidation

java.lang.Object
  com.oberon.ooql.sdk.OBBase
      com.oberon.ooql.sdk.ObjectValidation

All Implemented Interfaces:

java.io.Serializable

public class ObjectValidation
extends OBBase

Class used to retrieve Lifecycle-Stage-Validations for a specific ObjectObj.

Version:

5.0

See Also:

Serialized Form

Field Summary

static int	VAL_IGNORED Validation ignored
static int	VAL_REFUSED Validation refused
static int	VAL_UNSIGNED Validation unsigned
static int	VAL_VALIDATED Validation validated

Constructor Summary

ObjectValidation()

ObjectValidation(java.lang.String name)
Define new Object Validation

Method Summary

java.lang.String	accessToString(Framework framework) Get the list of framework User validation accesses for the current ObjectValidation
java.lang.String	accessToString(java.lang.String userName, Framework framework) Get the list of User validation accesses for the current ObjectObj at this Stage (as String)
void	fromXML(org.jdom.Element rootElement) Load the ObjectValidation from XML element tree
java.lang.String	getComment() Get the ObjectValidation comment
void	getHistory(Framework framework) [Inherited but not used]
java.lang.String	getName() Get the ObjectValidation name
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 ObjectValidation by its OOQL identifier
java.lang.String	getSigner() Get the ObjectValidation signer
ObjectStage	getStage() Get the ObjectValidation relative ObjectStage
java.lang.String	getStageFork() Get the ObjectValidation relative Stage-fork
int	getStatus() Get the ObjectValidation status
java.lang.String	getStatusAsString() Get the validation status in OOQL format
static int	getStatusFromString(java.lang.String status) Convert the ObjectValidation status from OOQL format to internal constant
java.util.Vector<?>	getTargetNames(java.lang.String composedName, java.util.Vector<java.lang.Object> filterArgs, Framework framework) [Inherited but not used]
boolean	isIgnored() Check if the ObjectValidation is ignored
boolean	isRefused() Check if the ObjectValidation is refused
boolean	isSigned() Check if the ObjectValidation is signed
boolean	isValidated() Check if the ObjectValidation is validated
void	setComment(java.lang.String comment) Set the ObjectValidation comment [INTERNAL USAGE]
void	setName(java.lang.String name) Set the ObjectValidation name [INTERNAL USAGE]
void	setSigner(java.lang.String userName) Set the ObjectValidation signer [INTERNAL USAGE]
void	setStage(ObjectStage stage) Set the ObjectValidation relative ObjectStage [INTERNAL USAGE]
void	setStageFork(java.lang.String stageFork) Set the ObjectValidation relative Stage-fork [INTERNAL USAGE]
void	setStatus(int status) Set the ObjectValidation status [INTERNAL USAGE]
java.lang.String	toString() Return the ObjectValidation basic properties as String
java.lang.String	toString(java.lang.String indent) Return the ObjectValidation basic properties as String
org.jdom.Element	toXML(Framework framework) Return the ObjectValidation properties as XML element tree

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

VAL_UNSIGNED

public static final int VAL_UNSIGNED

Validation unsigned

See Also:

Constant Field Values

VAL_VALIDATED

public static final int VAL_VALIDATED

Validation validated

See Also:

Constant Field Values

VAL_REFUSED

public static final int VAL_REFUSED

Validation refused

See Also:

Constant Field Values

VAL_IGNORED

public static final int VAL_IGNORED

Validation ignored

See Also:

Constant Field Values

Constructor Detail

ObjectValidation

public ObjectValidation()

ObjectValidation

public ObjectValidation(java.lang.String name)

Define new Object Validation

Parameters:

name - the validation name

Method Detail

setName

public void setName(java.lang.String name)

Set the ObjectValidation name [INTERNAL USAGE]

getName

public java.lang.String getName()

Get the ObjectValidation name

Specified by:

getName in class OBBase

setStage

public void setStage(ObjectStage stage)

Set the ObjectValidation relative ObjectStage [INTERNAL USAGE]

getStage

public ObjectStage getStage()

Get the ObjectValidation relative ObjectStage

setStageFork

public void setStageFork(java.lang.String stageFork)

Set the ObjectValidation relative Stage-fork [INTERNAL USAGE]

getStageFork

public java.lang.String getStageFork()

Get the ObjectValidation relative Stage-fork

setSigner

public void setSigner(java.lang.String userName)

Set the ObjectValidation signer [INTERNAL USAGE]

Parameters:

userName - the name of signer User

getSigner

public java.lang.String getSigner()

Get the ObjectValidation signer

Returns:

the name of signer User

setComment

public void setComment(java.lang.String comment)

Set the ObjectValidation comment [INTERNAL USAGE]

getComment

public java.lang.String getComment()

Get the ObjectValidation comment

Returns:

the comment wrote by signer User

setStatus

public void setStatus(int status)

Set the ObjectValidation status [INTERNAL USAGE]

getStatus

public int getStatus()

Get the ObjectValidation status

getStatusAsString

public java.lang.String getStatusAsString()

Get the validation status in OOQL format

getStatusFromString

public static int getStatusFromString(java.lang.String status)

Convert the ObjectValidation status from OOQL format to internal constant

isSigned

public boolean isSigned()

Check if the ObjectValidation is signed

isValidated

public boolean isValidated()

Check if the ObjectValidation is validated

isIgnored

public boolean isIgnored()

Check if the ObjectValidation is ignored

isRefused

public boolean isRefused()

Check if the ObjectValidation is refused

accessToString

public java.lang.String accessToString(Framework framework)

Get the list of framework User validation accesses for the current ObjectValidation

Parameters:

framework - the current framework

Returns:

access flags in OOQL format separated with commas

See Also:

Validation.hasValidateAccess(String,Framework), Validation.hasIgnoreAccess(String,Framework), Validation.hasRefuseAccess(String,Framework)

accessToString

public java.lang.String accessToString(java.lang.String userName,
                                       Framework framework)

Get the list of User validation accesses for the current ObjectObj at this Stage (as String)

Parameters:

userName - the name of user to get the access

framework - the current framework

Returns:

access flags in OOQL format separated with commas

See Also:

Validation.hasValidateAccess(String,String,Framework), Validation.hasIgnoreAccess(String,String,Framework), Validation.hasRefuseAccess(String,String,Framework)

getHistory

public void getHistory(Framework framework)
                throws OberonException

[Inherited but not used]

Throws:

OberonException

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 ObjectValidation by its OOQL identifier

Specified by:

getProperty in class OBBase

Parameters:

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

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)

[Inherited but not used]

Specified by:

getTargetNames in class OBBase

toXML

public org.jdom.Element toXML(Framework framework)

Return the ObjectValidation properties as XML element tree

Parameters:

framework - the current framework

fromXML

public void fromXML(org.jdom.Element rootElement)

Load the ObjectValidation from XML element tree

toString

public java.lang.String toString()

Return the ObjectValidation basic properties as String

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(java.lang.String indent)

Return the ObjectValidation basic properties as String

Parameters:

indent - set the row indent chars