org.opencrx.kernel.document1.cci2
Interface DocumentLock

All Superinterfaces:

BasicObject, ContextCapable, Creatable, ExtentCapable, Modifiable, SecureObject

All Known Subinterfaces:

DocumentLock

All Known Implementing Classes:

DocumentLock

public interface DocumentLock
extends SecureObject, BasicObject

Class DocumentLock

Nested Class Summary

static interface

DocumentLock.Identity Object Identity

Method Summary

String	getDescription() Retrieves the possibly null value for the optional attribute description.
Date	getLockedAt() Retrieves the possibly null value for the optional attribute lockedAt.
List<String>	getLockedBy() Retrieves a list containing all the elements for the attribute lockedBy.
String	getName() Retrieves the value for the attribute name.
void	setDescription(String description) Sets a new value for the attribute description.
void	setLockedAt(Date lockedAt) Sets a new value for the attribute lockedAt.
void	setLockedBy(String... lockedBy) Clears lockedBy and adds the given value(s).
void	setName(String name) Sets a new value for the attribute name.

Methods inherited from interface org.opencrx.kernel.base.cci2.SecureObject

addOwningGroup, checkPermissions, getAccessGrantedByParent, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwningGroup, getOwningUser, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwner, setOwningUser, setOwningUser

Methods inherited from interface org.openmdx.base.cci2.Creatable

getCreatedAt, getCreatedBy

Methods inherited from interface org.openmdx.base.cci2.ExtentCapable

getIdentity

Methods inherited from interface org.openmdx.base.cci2.Modifiable

getModifiedAt, getModifiedBy

Method Detail

getDescription

String getDescription()

Retrieves the possibly null value for the optional attribute description.

Returns:

The possibly null value for attribute description.

setDescription

void setDescription(String description)

Sets a new value for the attribute description.

Parameters:

description - The possibly null new value for attribute description.

getLockedAt

Date getLockedAt()

Retrieves the possibly null value for the optional attribute lockedAt.

Returns:

The possibly null value for attribute lockedAt.

setLockedAt

void setLockedAt(Date lockedAt)

Sets a new value for the attribute lockedAt.

Parameters:

lockedAt - The possibly null new value for attribute lockedAt.

getLockedBy

List<String> getLockedBy()

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

Returns:

A list containing all elements for this attribute.

setLockedBy

void setLockedBy(String... lockedBy)

Clears lockedBy and adds the given value(s).

This method is equivalent to

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

Parameters:

lockedBy - value(s) to be added to lockedBy

getName

String getName()

Retrieves the value for the attribute name.

Returns:

The non-null value for attribute name.

setName

void setName(String name)

Sets a new value for the attribute name.

Parameters:

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