6.0 Action Request System Java API: Class WorkflowLockInfo

Overview

Package

Class

Tree

Deprecated

Index

Help

6.0 Action Request System Java API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.remedy.arsys.api
Class WorkflowLockInfo

java.lang.Object
  |
  +--com.remedy.arsys.api.WorkflowLockInfo

All Implemented Interfaces:: java.lang.Cloneable

public class WorkflowLockInfo
extends java.lang.Object
implements java.lang.Cloneable

The WorkflowLockInfo class represents detailed information about workflow lock.

Constructor Summary

WorkflowLockInfo(int lockType, AccessNameID lockKey)


Method Summary

java.lang.Object clone()
          Clone implementation that returns an Object with data cloned from self

boolean equals(java.lang.Object anObject)
          Use this method for checking equality.

AccessNameID getLockKey()
          Returns the value of the lock key.

int getLockType()
          Returns a value identifying the workflow lock type.

int hashCode()
          Returns the hash code value for this instance of the current class.

void setLockKey(AccessNameID lockKey)
          Sets the value of the lock key.

void setLockType(int lockType)
          Sets a value identifying the workflow lock type.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowLockInfo

public WorkflowLockInfo(int lockType,
                        AccessNameID lockKey)

Method Detail

getLockKey

public AccessNameID getLockKey()

Returns the value of the lock key. This is a string that is used as a key (or a password) to enforce the locking.

setLockKey

public void setLockKey(AccessNameID lockKey)

Sets the value of the lock key. This is a string that is used as a key (or a password) to enforce the locking.

getLockType

public int getLockType()

Returns a value identifying the workflow lock type.

0: Object is unlocked (AR_LOCK_TYPE_NONE)
1: Object has a read-only lock and is readable but not modifiable (AR_LOCK_TYPE_READONLY)
2: Object has a hidden-lock and cannot be read or modified (AR_LOCK_TYPE_HIDDEN)

setLockType

public void setLockType(int lockType)

Sets a value identifying the workflow lock type.

0: Object is unlocked (AR_LOCK_TYPE_NONE)
1: Object has a read-only lock and is readable but not modifiable (AR_LOCK_TYPE_READONLY)
2: Object has a hidden-lock and cannot be read or modified (AR_LOCK_TYPE_HIDDEN)

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self

Overrides:: clone in class java.lang.Object

equals

public boolean equals(java.lang.Object anObject)

Use this method for checking equality. The result is true only if the argument is not null, is of same type and represents the same content.

Overrides:: equals in class java.lang.Object

hashCode

public int hashCode()

Returns the hash code value for this instance of the current class. This method is supported as required by the general contract of Object.hashCode, for the benefit of hash tables such as those provided by java.util.Hashtable.

Overrides:: hashCode in class java.lang.Object