wt.locks
Interface Lockable

All Superinterfaces:

NetFactor, ObjectMappable, Persistable, Serializable

All Known Subinterfaces:

Baseline, BaselineConfigurationVersion, IteratedPartialBaseline, MarkUp, NonStrictBaseline, SerialNumberedBaselineConfigurationVersion, Workable

All Known Implementing Classes:

AnnotationBaseline, CounterPartDelta, DefaultWTContainerTemplate, EPMAsStoredConfig, EPMCheckpoint, EventLog, IteratedFolderResident, ManagedBaseline, MaturityBaseline, QueueEntry, ReplicationBaseline, RevisionControlled, SandboxBaseline, ScheduleQueueEntry, WfProcessTemplate, WTMarkUp, WTProductConfiguration

public interface Lockable

extends Persistable

Provides an abstraction of a plug-and-play component. The intent is that in a business model a business object would assert that it is Lockable by inheriting (i.e., implements) the Lockable interface. With this assertion the business object can then be (un)locked through the locking service's API.

Supported API: true

Extendable: true

See Also:

LockHelper, LockHelper.service

Field Summary

static String	LOCK Label for the attribute; The lock mechanism/cookie aggregated in any business object that asserts itself as being lockable.
static String	LOCK_DATE Label for the attribute; Derived attribute for displaying the lock date value in query results.
static String	LOCK_NOTE Label for the attribute; Derived attribute for displaying the lock note value in query results.
static String	LOCKED Label for the attribute; Derived attribute for displaying the isSeized value in query results.
static String	LOCKER Label for the attribute; Derived attribute for querying for the locker.
static String	LOCKER_EMAIL Label for the attribute; Derived attribute for displaying the locker E-Mail value in query results.
static String	LOCKER_FULL_NAME Label for the attribute; Derived attribute for displaying the lock fullname value in query results.
static String	LOCKER_NAME Label for the attribute; Derived attribute for displaying the locker name value in query results.

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Method Summary

Lock	getLock() Gets the object for the association that plays role: LOCK.
Timestamp	getLockDate() Gets the value of the attribute: LOCK_DATE.
WTPrincipalReference	getLocker() Gets the value of the attribute: LOCKER.
String	getLockerEMail() Gets the value of the attribute: LOCKER_EMAIL.
String	getLockerFullName() Gets the value of the attribute: LOCKER_FULL_NAME.
String	getLockerName() Gets the value of the attribute: LOCKER_NAME.
String	getLockNote() Gets the value of the attribute: LOCK_NOTE.
boolean	isLocked() Gets the value of the attribute: LOCKED.
void	setLock(Lock a_Lock) Sets the object for the association that plays role: LOCK.

Methods inherited from interface wt.fc.Persistable

checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.ObjectMappable

readExternal, writeExternal

Methods inherited from interface wt.fc.NetFactor

getClassInfo, getConceptualClassname

Field Detail

LOCKED

public static final String LOCKED

Label for the attribute; Derived attribute for displaying the isSeized value in query results.

Supported API: false

See Also:

Constant Field Values

LOCK_DATE

public static final String LOCK_DATE

Label for the attribute; Derived attribute for displaying the lock date value in query results.

Supported API: false

See Also:

Constant Field Values

LOCK_NOTE

public static final String LOCK_NOTE

Label for the attribute; Derived attribute for displaying the lock note value in query results.

Supported API: false

See Also:

Constant Field Values

LOCKER

public static final String LOCKER

Label for the attribute; Derived attribute for querying for the locker.

Supported API: false

See Also:

Constant Field Values

LOCKER_EMAIL

public static final String LOCKER_EMAIL

Label for the attribute; Derived attribute for displaying the locker E-Mail value in query results.

Supported API: false

See Also:

Constant Field Values

LOCKER_NAME

public static final String LOCKER_NAME

Label for the attribute; Derived attribute for displaying the locker name value in query results.

Supported API: false

See Also:

Constant Field Values

LOCKER_FULL_NAME

public static final String LOCKER_FULL_NAME

Label for the attribute; Derived attribute for displaying the lock fullname value in query results.

Supported API: false

See Also:

Constant Field Values

LOCK

public static final String LOCK

Label for the attribute; The lock mechanism/cookie aggregated in any business object that asserts itself as being lockable.

Supported API: false

See Also:

Lock, Constant Field Values

Method Detail

isLocked

public boolean isLocked()

Gets the value of the attribute: LOCKED. Derived attribute for displaying the isSeized value in query results.

Supported API: false

Returns:

boolean

getLockDate

public Timestamp getLockDate()

Gets the value of the attribute: LOCK_DATE. Derived attribute for displaying the lock date value in query results.

Supported API: false

Returns:

Timestamp

getLockNote

public String getLockNote()

Gets the value of the attribute: LOCK_NOTE. Derived attribute for displaying the lock note value in query results.

Supported API: false

Returns:

String

getLocker

public WTPrincipalReference getLocker()

Gets the value of the attribute: LOCKER. Derived attribute for querying for the locker.

Supported API: false

Returns:

WTPrincipalReference

getLockerEMail

public String getLockerEMail()

Gets the value of the attribute: LOCKER_EMAIL. Derived attribute for displaying the locker E-Mail value in query results.

Supported API: false

Returns:

String

getLockerName

public String getLockerName()

Gets the value of the attribute: LOCKER_NAME. Derived attribute for displaying the locker name value in query results.

Supported API: false

Returns:

String

getLockerFullName

public String getLockerFullName()

Gets the value of the attribute: LOCKER_FULL_NAME. Derived attribute for displaying the lock fullname value in query results.

Supported API: false

Returns:

String

getLock

public Lock getLock()

Gets the object for the association that plays role: LOCK. The lock mechanism/cookie aggregated in any business object that asserts itself as being lockable.

Supported API: false

Returns:

Lock

See Also:

Lock

setLock

public void setLock(Lock a_Lock)
             throws WTPropertyVetoException

Sets the object for the association that plays role: LOCK. The lock mechanism/cookie aggregated in any business object that asserts itself as being lockable.

Supported API: false

Parameters:

a_Lock -

Throws:

WTPropertyVetoException

See Also:

Lock