com.arcway.cockpit.docgen.provider.interfaces

Interface ILockOnServer

public interface ILockOnServer

Represents a lock set on the server.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClientName() Returns the name of the client that created the lock.
java.lang.Long	getCreationTime() Returns the creation time of the lock.
java.lang.String	getLockedItemType() Returns the type of the locked item.
java.lang.String	getLockedItemUID() Returns the UID of the locked item.
java.lang.String	getLockTypeID() Returns the ID of the lock type.
java.lang.String	getProjectUID() Returns the UID of the project this lock belongs to.
java.lang.String	getUID() Returns the UID of the lock.
java.lang.String	getUserName() Returns the name of the user that created the lock.

Method Detail

getUID

java.lang.String getUID()

Returns the UID of the lock.

Returns:

UID of the lock

getProjectUID

java.lang.String getProjectUID()

Returns the UID of the project this lock belongs to.

Returns:

UID of the project

getLockTypeID

java.lang.String getLockTypeID()

Returns the ID of the lock type.

Returns:

ID of the lock type

getLockedItemUID

java.lang.String getLockedItemUID()

Returns the UID of the locked item.

Returns:

UID of the locked item

getLockedItemType

java.lang.String getLockedItemType()

Returns the type of the locked item.

Returns:

type of the locked item, like "Plan", "Section", or "Project"

getClientName

java.lang.String getClientName()

Returns the name of the client that created the lock.

Returns:

String client name

getUserName

java.lang.String getUserName()

Returns the name of the user that created the lock.

Returns:

name of the user that created the lock

getCreationTime

java.lang.Long getCreationTime()

Returns the creation time of the lock.

Use IDateTimeProvider to format the time.

Returns:

creation time (in milliseconds since 1970)