com.eruces.teadmin.ACLInfo

The ACLInfo class manages a principal's TTag container rights.

Inheritance

• Inherits com.eruces.teadmin.UpdatableObject

Public Member Functions

Member	Description
ACLInfo()	The TEACLInfo constructor is the default class constructor.
ACLEntry findACLEntry(PrincipalInfo principal)	Find ACL Entry of particular principal.
boolean addACLEntry(ACLEntry aclEntry)	The addACLEntry method adds a new ACL entry to an ACLInfo object.
void removeACLEntry(int nIndex)	The removeACLEntry method removes an ACL entry from an ACLInfo object.
void removeACLEntry(ACLEntry ae)	The removeACLEntry method removes an ACL entry from an ACLInfo object.
void clearACLEntry()	The clearACLEntry method purges all ACL entries.
int getACLEntryCount()	The getACLEntryCount method gets the total number of entries in an ACL.
ACLEntry getACLEntry(int nIdx)	The getACLEntry method gets an ACLEntry object.
ACLEntry getACLEntry(ACLEntry ae)	The getACLEntry method gets an ACLEntry object.
void updateACLEntry(int nIdx, ACLEntry acl)	The updateACLEntry method updates a specific ACL entry.
void updateACLEntry(ACLEntry acl)	The updateACLEntry method updates a specific ACL entry.
Date getCreationTimeStamp()	The getCreationTimeStamp method gets gets the timestamp issued when an ACLInfo object was created.
String getHiddenLink()	The getHiddenLink method gets a Base64-encoded TTag.
byte[] getRawHiddenLink()	The getRawHiddenLink method gets a byte array of a TTag.
void setHiddenLink(String strHiddenLink)	The setHiddenLink method sets a Base64-encoded TTag.
void setRawHiddenLink(byte[] strHiddenLink)	The setRawHiddenLink method sets a byte array of a TTag.
long getACLID()	The getACLID method gets an access control list identifier.
boolean isExpired()	The isExpired method checks whether an ACL has expired.
void setExpirationStatus(boolean bExp)	The setExpirationStatus method sets the expiration status of an ACL.
void setACLID(long nID)	The setACLID method sets a unique identifier for an ACL.
String toString()	The toString method converts ACLInfo object data to a string.

Member Function Documentation

ACLInfo()

The TEACLInfo constructor is the default class constructor.

ACLEntry findACLEntry(PrincipalInfo principal)

Find ACL Entry of particular principal.

Parameters

Parameter	Description
principal	principal object

Returns: ACLEntry

boolean addACLEntry(ACLEntry aclEntry)

The addACLEntry method adds a new ACL entry to an ACLInfo object.

Parameters

Parameter	Description
aclEntry	An ACL entry object.

Returns: TRUE/FALSE Returns a boolean value indicating whether the operation was successful: TRUE = ACLEntry object was added to ACLInfo object; FALSE = ACLEntry object was not added to ACLInfo object.

void removeACLEntry(int nIndex)

The removeACLEntry method removes an ACL entry from an ACLInfo object.

Deprecated

Parameters

Parameter	Description
nIndex	An integer representing the index of the ACL entry to be removed.

void removeACLEntry(ACLEntry ae)

The removeACLEntry method removes an ACL entry from an ACLInfo object.

Parameters

Parameter	Description
ae	An ACL entry inside this ACL

void clearACLEntry()

The clearACLEntry method purges all ACL entries.

int getACLEntryCount()

The getACLEntryCount method gets the total number of entries in an ACL.

Returns: Returns an integer representing the total number of entries in an ACL.

ACLEntry getACLEntry(int nIdx)

The getACLEntry method gets an ACLEntry object.

Deprecated

Parameters

Parameter	Description
nIdx	index of ACL Entry

Returns: ACLEntry

ACLEntry getACLEntry(ACLEntry ae)

The getACLEntry method gets an ACLEntry object.

Deprecated

Parameters

Parameter	Description
ae	index of ACL Entry

Returns: ACLEntry

void updateACLEntry(int nIdx, ACLEntry acl)

The updateACLEntry method updates a specific ACL entry.

Deprecated

Parameters

Parameter	Description
nIdx	An integer representing the index of the ACL entry to be updated.
acl	An ACLEntry object.

void updateACLEntry(ACLEntry acl)

The updateACLEntry method updates a specific ACL entry.

Parameters

Parameter	Description
acl	An ACLEntry object.

Date getCreationTimeStamp()

The getCreationTimeStamp method gets gets the timestamp issued when an ACLInfo object was created.

Returns: Returns an ACLInfo object creation timestamp.

String getHiddenLink()

The getHiddenLink method gets a Base64-encoded TTag.

Returns: Returns a string representing a Base64-encoded TTag.

byte[] getRawHiddenLink()

The getRawHiddenLink method gets a byte array of a TTag.

Returns: Returns a byte array representing the value of the TTag.

void setHiddenLink(String strHiddenLink)

The setHiddenLink method sets a Base64-encoded TTag.

Parameters

Parameter	Description
strHiddenLink	A string representing a Base64-encoded TTag.

void setRawHiddenLink(byte[] strHiddenLink)

The setRawHiddenLink method sets a byte array of a TTag.

Parameters

Parameter	Description
strHiddenLink	A byte array representing a TTag.

long getACLID()

The getACLID method gets an access control list identifier.

Returns: Returns an integer representing an ACL ID.

boolean isExpired()

The isExpired method checks whether an ACL has expired.

Returns: Returns a boolean value representing the status of an ACL; True = ACL is valid, False = ACL has expired.

void setExpirationStatus(boolean bExp)

The setExpirationStatus method sets the expiration status of an ACL.

Parameters

Parameter	Description
bExp	A boolean value representing the status of the ACL; True = expired, False = not expired.

void setACLID(long nID)

The setACLID method sets a unique identifier for an ACL.

Parameters

Parameter	Description
nID	An integer representing a unique ACL ID.

String toString()

The toString method converts ACLInfo object data to a string.

Returns: Returns a string representing ACLInfo data.

Remark: Overrides the toString method in the com.eruces.teadmin.UpdatableObject class.