com.eruces.teadmin.ACLTemplateMember
The ACLTemplateMember represents an ACL template member.
Inheritance
- Inherits com.eruces.teadmin.UpdatableObject
- Inherits Comparable
Static Public Attributes
| Type | Name | Description |
|---|---|---|
| final int | ACL_TEMPLATE_READ | A flag indicating if the principal can read ACL Template information. |
| final int | ACL_TEMPLATE_WRITE | A flag indicating if the principal can update ACL Template information. |
Public Member Functions
| Member | Description |
|---|---|
ACLTemplateMember() | The default constructor. |
long getACLTemplateID() | The getACLTemplateID method gets and ACL Template ID. |
void setACLTemplateID(long nACLTemplateID) | The setACLTemplateID method sets and ACL Template ID. |
int getSystemID() | The getSystemID method gets a System ID. |
void setSystemID(int nSystemID) | The setSystemID method sets a System ID. |
long getPrincipalID() | The getPrincipalID method gets a principal ID. |
void setPrincipalID(long nPrincipalID) | The setPrincipalID method sets a principal ID. |
int getRights() | The getRights method retrieve the user's rights to the template. |
void setRights(int nRights) | The setRights method sets the user's rights to the template. |
long getStartTime() | The getStartTime method gets the start time. |
void setStartTime(long nTime) | The setStartTime method sets the start time. |
long getEndTime() | The getEndTime method retrieves the end time. |
void setEndTime(long nTime) | The setEndTime method sets the end time. |
int getMaxUsage() | The getMaxUsage method gets the maximum number of times a principal can use the key. |
void setMaxUsage(int usage) | The setMaxUsage method sets the maximum number of times a principal can use the key. |
String toString() | The toString method converts ACL Template Member object into a string. |
boolean equals(Object obj) | The equals method determines if two ACL template members are identical. |
int compareTo(Object obj) | The compareTos method determines if two ACL template members are similar. |
Member Function Documentation
ACLTemplateMember()
The default constructor.
long getACLTemplateID()
The getACLTemplateID method gets and ACL Template ID.
Returns: ACL An integer representing the template ID.
void setACLTemplateID(long nACLTemplateID)
The setACLTemplateID method sets and ACL Template ID.
Parameters
| Parameter | Description |
|---|---|
nACLTemplateID | An integer representing the template ID. |
int getSystemID()
The getSystemID method gets a System ID.
Returns: An integer representing the system ID.
void setSystemID(int nSystemID)
The setSystemID method sets a System ID.
Parameters
| Parameter | Description |
|---|---|
nSystemID | An integer representing the system ID. |
long getPrincipalID()
The getPrincipalID method gets a principal ID.
Returns: An integer representing the principal ID
void setPrincipalID(long nPrincipalID)
The setPrincipalID method sets a principal ID.
Parameters
| Parameter | Description |
|---|---|
nPrincipalID | An integer representing the principal ID. |
int getRights()
The getRights method retrieve the user's rights to the template.
See also: ACL_TEMPLATE_READ, ACL_TEMPLATE_WRITE
Returns: An integer representing the cummulative rights.
void setRights(int nRights)
The setRights method sets the user's rights to the template.
Parameters
| Parameter | Description |
|---|---|
nRights | An integer representing the cummulative rights. |
See also: ACL_TEMPLATE_READ, ACL_TEMPLATE_WRITE
long getStartTime()
The getStartTime method gets the start time.
Returns: A long representing the start time.
void setStartTime(long nTime)
The setStartTime method sets the start time.
Parameters
| Parameter | Description |
|---|---|
nTime | A long representing the start time. |
long getEndTime()
The getEndTime method retrieves the end time.
Returns: A long representing the end time.
void setEndTime(long nTime)
The setEndTime method sets the end time.
Parameters
| Parameter | Description |
|---|---|
nTime | A long representing the end time. |
int getMaxUsage()
The getMaxUsage method gets the maximum number of times a principal can use the key.
Returns: An integer representing the maximum usage. -1 means unlimited use.
void setMaxUsage(int usage)
The setMaxUsage method sets the maximum number of times a principal can use the key.
Parameters
| Parameter | Description |
|---|---|
usage | An integer representing the maximum usage. -1 means unlimited use. |
String toString()
The toString method converts ACL Template Member object into a string.
Returns: A string representing the ACL Template Member.
boolean equals(Object obj)
The equals method determines if two ACL template members are identical.
Returns: A boolean representing whether or not two ACL template members are identical. True=identical, False=not the same
int compareTo(Object obj)
The compareTos method determines if two ACL template members are similar.
Returns: An integer representing whether or not two ACL template members are similar. 0=identical, 1=different, -1=not the same