org.xmlecho.palomar.xfs
Interface ItemLock


public interface ItemLock

interface to a (DAV) lock's information.


Field Summary
static int DEPTH_INFINITY
           
static int DEPTH_ZERO
           
static java.lang.String SCOPE_EXCLUSIVE
           
static java.lang.String SCOPE_SHARED
           
static java.lang.String SCOPE_UNKNOWN
           
static java.lang.String TYPE_UNKNOWN
           
static java.lang.String TYPE_WRITE
           
 
Method Summary
 java.util.Date getCreationDate()
          Get the value of _creationDate.
 int getDepth()
          Get the value of _depth.
 long getExpiresAt()
          Get the value of _expiresAt.
 java.lang.String getItemID()
          get the repository item id
 java.lang.String getLockID()
          get lock id
 java.lang.String getOwner()
          Get the value of _owner.
 java.lang.String getPath()
          Get the value of _path.
 java.lang.String getScope()
          Get the value of _scope.
 java.util.Vector getTokens()
          Get the value of _tokens.
 java.lang.String getType()
          Get the value of _type.
 boolean hasExpired()
          Return true if the lock has expired.
 boolean isExclusive()
          Return true if the lock is exclusive.
 void setCreationDate(java.util.Date v)
          Set the value of _creationDate.
 void setDepth(int v)
          Set the value of _depth.
 void setExpiresAt(long v)
          Set the value of _expiresAt.
 void setItemID(java.lang.String itemID)
          set the repository item which is to be locked with this lock
 void setLockID(java.lang.String path)
          set the unique identifier for this lock
 void setOwner(java.lang.String v)
          Set the value of _owner.
 void setPath(java.lang.String path)
          get the repository item path
 void setScope(java.lang.String v)
          Set the value of _scope.
 void setTokens(java.util.Vector v)
          Set the value of _tokens.
 void setType(java.lang.String v)
          Set the value of _type.
 java.lang.String toString()
          Get a String representation of this lock
 

Field Detail

SCOPE_UNKNOWN

public static final java.lang.String SCOPE_UNKNOWN
See Also:
Constant Field Values

SCOPE_EXCLUSIVE

public static final java.lang.String SCOPE_EXCLUSIVE
See Also:
Constant Field Values

SCOPE_SHARED

public static final java.lang.String SCOPE_SHARED
See Also:
Constant Field Values

TYPE_UNKNOWN

public static final java.lang.String TYPE_UNKNOWN
See Also:
Constant Field Values

TYPE_WRITE

public static final java.lang.String TYPE_WRITE
See Also:
Constant Field Values

DEPTH_INFINITY

public static final int DEPTH_INFINITY
See Also:
Constant Field Values

DEPTH_ZERO

public static final int DEPTH_ZERO
See Also:
Constant Field Values
Method Detail

getPath

public java.lang.String getPath()
Get the value of _path.

Returns:
value of _path.

getType

public java.lang.String getType()
Get the value of _type.

Returns:
value of _type.

setType

public void setType(java.lang.String v)
Set the value of _type.

Parameters:
v - Value to assign to _type.

getScope

public java.lang.String getScope()
Get the value of _scope.

Returns:
value of _scope.

setScope

public void setScope(java.lang.String v)
Set the value of _scope.

Parameters:
v - Value to assign to _scope.

getDepth

public int getDepth()
Get the value of _depth.

Returns:
value of _depth.

setDepth

public void setDepth(int v)
Set the value of _depth.

Parameters:
v - Value to assign to _depth.

getOwner

public java.lang.String getOwner()
Get the value of _owner.

Returns:
value of _owner.

setOwner

public void setOwner(java.lang.String v)
Set the value of _owner.

Parameters:
v - Value to assign to _owner.

getTokens

public java.util.Vector getTokens()
Get the value of _tokens.

Returns:
value of _tokens.

setTokens

public void setTokens(java.util.Vector v)
Set the value of _tokens.

Parameters:
v - Value to assign to _tokens.

getExpiresAt

public long getExpiresAt()
Get the value of _expiresAt.

Returns:
value of _expiresAt.

setExpiresAt

public void setExpiresAt(long v)
Set the value of _expiresAt.

Parameters:
v - Value to assign to _expiresAt.

getCreationDate

public java.util.Date getCreationDate()
Get the value of _creationDate.

Returns:
value of _creationDate.

setCreationDate

public void setCreationDate(java.util.Date v)
Set the value of _creationDate.

Parameters:
v - Value to assign to _creationDate.

toString

public java.lang.String toString()
Get a String representation of this lock


hasExpired

public boolean hasExpired()
Return true if the lock has expired.


isExclusive

public boolean isExclusive()
Return true if the lock is exclusive.


setItemID

public void setItemID(java.lang.String itemID)
set the repository item which is to be locked with this lock


getItemID

public java.lang.String getItemID()
get the repository item id


setPath

public void setPath(java.lang.String path)
get the repository item path


setLockID

public void setLockID(java.lang.String path)
set the unique identifier for this lock


getLockID

public java.lang.String getLockID()
get lock id