|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.novell.sentinel.client.bean.SentinelBean
com.novell.db.object.bean.UserPermissionsBean
public class UserPermissionsBean
An automatically-generated "bean" class for the Sentinel data object type 'permissions
'.
The description of the type is:
"The UserPermissions object contains the current permissions for a user in the Sentinel system."
The Sentinel data object bean classes are designed to be used to transport data to and from the Sentinel server. There exists a supporting infrastructure that handles the serialization/parsing of the data to/from the JSON transport format and which handles the actual HTTP transport.
A more complete description of Sentinel data object beans is found in the description
of SentinelBean
.
SentinelBean
,
BeanTransporter
Field Summary | |
---|---|
static String |
ADMIN
The "bean name" of the Sentinel data object field 'Admin'. |
static String |
ALLOWALLEVENTS
The "bean name" of the Sentinel data object field 'AllowAllEvents'. |
static String |
CANCHANGEOWNPASSWORD
The "bean name" of the Sentinel data object field 'CanChangeOwnPassword'. |
static String |
EFFECTIVEPERMISSIONS
The "bean name" of the Sentinel data object field 'EffectivePermissions'. |
static String |
EVENTFILTER
The "bean name" of the Sentinel data object field 'EventFilter'. |
Constructor Summary | |
---|---|
|
UserPermissionsBean()
Construct an instance of the bean class. |
protected |
UserPermissionsBean(BeanMetaData<? extends SentinelBean> metadata)
Constructor for use by derived classes. |
Method Summary | |
---|---|
void |
addToEffectivePermissions(String value)
Add a value to the collection field ' perm-set '. |
void |
clearAdmin()
Clear any current value for the ' isadmin ' field in the bean. |
void |
clearAllowAllEvents()
Clear any current value for the ' all-events ' field in the bean. |
void |
clearCanChangeOwnPassword()
Clear any current value for the ' chg-pwd ' field in the bean. |
void |
clearEffectivePermissions()
Clear any current value for the ' perm-set ' field in the bean. |
void |
clearEventFilter()
Clear any current value for the ' filter ' field in the bean. |
UserPermissionsBean |
clone()
Create a duplicate of this bean instance, including all field values. |
static BeanMetaData<? extends UserPermissionsBean> |
getBeanMetaData()
Get the metadata class instance for this type. |
Collection<String> |
getEffectivePermissions()
Get the value for the ' perm-set ' field. |
String |
getEventFilter()
Get the value for the ' filter ' field. |
boolean |
isAdmin()
Get the value for the ' isadmin ' field. |
boolean |
isAdminClear()
Get whether the value for the ' isadmin ' field is clear or not. |
boolean |
isAdminNull()
Get whether the ' isadmin ' field has been set to Null or not. |
boolean |
isAllowAllEvents()
Get the value for the ' all-events ' field. |
boolean |
isAllowAllEventsClear()
Get whether the value for the ' all-events ' field is clear or not. |
boolean |
isAllowAllEventsNull()
Get whether the ' all-events ' field has been set to Null or not. |
boolean |
isCanChangeOwnPassword()
Get the value for the ' chg-pwd ' field. |
boolean |
isCanChangeOwnPasswordClear()
Get whether the value for the ' chg-pwd ' field is clear or not. |
boolean |
isCanChangeOwnPasswordNull()
Get whether the ' chg-pwd ' field has been set to Null or not. |
boolean |
isEffectivePermissionsClear()
Get whether the value for the ' perm-set ' field is clear or not. |
boolean |
isEffectivePermissionsNull()
Get whether the ' perm-set ' field has been set to Null or not. |
boolean |
isEventFilterClear()
Get whether the value for the ' filter ' field is clear or not. |
boolean |
isEventFilterNull()
Get whether the ' filter ' field has been set to Null or not. |
void |
setAdmin(boolean admin)
Set the value for the ' isadmin ' field. |
void |
setAdminNull()
Set to Null any current value for the ' isadmin ' field in the
bean. |
void |
setAllowAllEvents(boolean allowAllEvents)
Set the value for the ' all-events ' field. |
void |
setAllowAllEventsNull()
Set to Null any current value for the ' all-events ' field in the
bean. |
void |
setCanChangeOwnPassword(boolean canChangeOwnPassword)
Set the value for the ' chg-pwd ' field. |
void |
setCanChangeOwnPasswordNull()
Set to Null any current value for the ' chg-pwd ' field in the
bean. |
void |
setEffectivePermissions(Collection<? extends String> effectivePermissions)
Set the value for the ' perm-set ' field. |
void |
setEffectivePermissionsNull()
Set to Null any current value for the ' perm-set ' field in the
bean. |
void |
setEventFilter(String eventFilter)
Set the value for the ' filter ' field. |
void |
setEventFilterNull()
Set to Null any current value for the ' filter ' field in the bean. |
Methods inherited from class com.novell.sentinel.client.bean.SentinelBean |
---|
clearField, cloneBean, equals, fields, getBeanName, getBeanValue, getField, getFieldNoNull, getLink, getMetaData, isFieldClear, isFieldNull, isLinkClear, setField, setFieldNull, toString, values |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String ADMIN
""isadmin""
.
The description of the 'isadmin
' field is:
"If true, the user has administrator privileges."
public static final String ALLOWALLEVENTS
""all-events""
.
The description of the 'all-events
' field is:
"If true, the user can view all event records in the Sentinel system. If false, the filter value is used to determine the set of events the user is allowed to view."
public static final String CANCHANGEOWNPASSWORD
""chg-pwd""
.
The description of the 'chg-pwd
' field is:
"If true, a user can change his own password."
public static final String EVENTFILTER
""filter""
.
The description of the 'filter
' field is:
"If non-empty, and AllowAllEvents is false, this value is a filter expression that determines the set of events the user is allowed to view."
public static final String EFFECTIVEPERMISSIONS
""perm-set""
.
The description of the 'perm-set
' field is:
"This collection contains the calculated set of permissions effective for the user based on the user's role memberships."
Constructor Detail |
---|
public UserPermissionsBean()
protected UserPermissionsBean(BeanMetaData<? extends SentinelBean> metadata)
metadata
- The metadata instance for the derived bean class. Normally this constructor
will only be called by generated code.Method Detail |
---|
public boolean isAllowAllEvents()
all-events
' field. The description of the 'all-events
'
field is:
"If true, the user can view all event records in the Sentinel system. If false, the filter value is used to determine the set of events the user is allowed to view."
null
).ALLOWALLEVENTS
public boolean isAllowAllEventsNull()
all-events
' field has been set to Null or not.
The description of the 'all-events
' field is:
"If true, the user can view all event records in the Sentinel system. If false, the filter value is used to determine the set of events the user is allowed to view."
See the description of Null values.
true
if the field value has been marked as null, false
otherwise.setAllowAllEventsNull()
,
ALLOWALLEVENTS
public boolean isAllowAllEventsClear()
all-events
' field is clear or not. The
description of the 'all-events
' field is:
"If true, the user can view all event records in the Sentinel system. If false, the filter value is used to determine the set of events the user is allowed to view."
See the description of cleared values.
true
if the field value has been cleared, false
otherwise.clearAllowAllEvents()
,
ALLOWALLEVENTS
public void setAllowAllEvents(boolean allowAllEvents)
all-events
' field. The description of the 'all-events
'
field is:
"If true, the user can view all event records in the Sentinel system. If false, the filter value is used to determine the set of events the user is allowed to view."
allowAllEvents
- Value to setALLOWALLEVENTS
public void clearAllowAllEvents()
all-events
' field in the bean. The
description of the 'all-events
' field is:
"If true, the user can view all event records in the Sentinel system. If false, the filter value is used to determine the set of events the user is allowed to view."
Using this method will not clear the server value when the bean is PUT to
the server.
Use the setAllowAllEventsNull()
method to clear the server's value.
See the description of cleared values.
ALLOWALLEVENTS
public void setAllowAllEventsNull()
all-events
' field in the
bean. The description of the 'all-events
' field is:
"If true, the user can view all event records in the Sentinel system. If false, the filter value is used to determine the set of events the user is allowed to view."
Using this method will clear the server value when the bean is PUT to the
server.
Use the clearAllowAllEvents()
method to avoid clearing the server's value.
See the description of Null values.
ALLOWALLEVENTS
public Collection<String> getEffectivePermissions()
perm-set
' field. The description of the 'perm-set
'
field is:
"This collection contains the calculated set of permissions effective for the user based on the user's role memberships."
null
).EFFECTIVEPERMISSIONS
public boolean isEffectivePermissionsNull()
perm-set
' field has been set to Null or not.
The description of the 'perm-set
' field is:
"This collection contains the calculated set of permissions effective for the user based on the user's role memberships."
See the description of Null values.
true
if the field value has been marked as null, false
otherwise.setEffectivePermissionsNull()
,
EFFECTIVEPERMISSIONS
public boolean isEffectivePermissionsClear()
perm-set
' field is clear or not. The
description of the 'perm-set
' field is:
"This collection contains the calculated set of permissions effective for the user based on the user's role memberships."
See the description of cleared values.
true
if the field value has been cleared, false
otherwise.clearEffectivePermissions()
,
EFFECTIVEPERMISSIONS
public void setEffectivePermissions(Collection<? extends String> effectivePermissions)
perm-set
' field. The description of the 'perm-set
'
field is:
"This collection contains the calculated set of permissions effective for the user based on the user's role memberships."
effectivePermissions
- Value to setEFFECTIVEPERMISSIONS
public void clearEffectivePermissions()
perm-set
' field in the bean. The description
of the 'perm-set
' field is:
"This collection contains the calculated set of permissions effective for the user based on the user's role memberships."
Using this method will not clear the server value when the bean is PUT to
the server.
Use the setEffectivePermissionsNull()
method to clear the server's value.
See the description of cleared values.
EFFECTIVEPERMISSIONS
public void setEffectivePermissionsNull()
perm-set
' field in the
bean. The description of the 'perm-set
' field is:
"This collection contains the calculated set of permissions effective for the user based on the user's role memberships."
Using this method will clear the server value when the bean is PUT to the
server.
Use the clearEffectivePermissions()
method to avoid clearing the server's
value.
See the description of Null values.
EFFECTIVEPERMISSIONS
public void addToEffectivePermissions(String value)
perm-set
'. The description of the
'perm-set
' field is:
"This collection contains the calculated set of permissions effective for the user based on the user's role memberships."
value
- Value to add to collection.EFFECTIVEPERMISSIONS
public boolean isCanChangeOwnPassword()
chg-pwd
' field. The description of the 'chg-pwd
'
field is:
"If true, a user can change his own password."
null
).CANCHANGEOWNPASSWORD
public boolean isCanChangeOwnPasswordNull()
chg-pwd
' field has been set to Null or not.
The description of the 'chg-pwd
' field is:
"If true, a user can change his own password."
See the description of Null values.
true
if the field value has been marked as null, false
otherwise.setCanChangeOwnPasswordNull()
,
CANCHANGEOWNPASSWORD
public boolean isCanChangeOwnPasswordClear()
chg-pwd
' field is clear or not. The description
of the 'chg-pwd
' field is:
"If true, a user can change his own password."
See the description of cleared values.
true
if the field value has been cleared, false
otherwise.clearCanChangeOwnPassword()
,
CANCHANGEOWNPASSWORD
public void setCanChangeOwnPassword(boolean canChangeOwnPassword)
chg-pwd
' field. The description of the 'chg-pwd
'
field is:
"If true, a user can change his own password."
canChangeOwnPassword
- Value to setCANCHANGEOWNPASSWORD
public void clearCanChangeOwnPassword()
chg-pwd
' field in the bean. The description
of the 'chg-pwd
' field is:
"If true, a user can change his own password."
Using this method will not clear the server value when the bean is PUT to
the server.
Use the setCanChangeOwnPasswordNull()
method to clear the server's value.
See the description of cleared values.
CANCHANGEOWNPASSWORD
public void setCanChangeOwnPasswordNull()
chg-pwd
' field in the
bean. The description of the 'chg-pwd
' field is:
"If true, a user can change his own password."
Using this method will clear the server value when the bean is PUT to the
server.
Use the clearCanChangeOwnPassword()
method to avoid clearing the server's
value.
See the description of Null values.
CANCHANGEOWNPASSWORD
public String getEventFilter()
filter
' field. The description of the 'filter
'
field is:
"If non-empty, and AllowAllEvents is false, this value is a filter expression that determines the set of events the user is allowed to view."
null
).EVENTFILTER
public boolean isEventFilterNull()
filter
' field has been set to Null or not. The
description of the 'filter
' field is:
"If non-empty, and AllowAllEvents is false, this value is a filter expression that determines the set of events the user is allowed to view."
See the description of Null values.
true
if the field value has been marked as null, false
otherwise.setEventFilterNull()
,
EVENTFILTER
public boolean isEventFilterClear()
filter
' field is clear or not. The description
of the 'filter
' field is:
"If non-empty, and AllowAllEvents is false, this value is a filter expression that determines the set of events the user is allowed to view."
See the description of cleared values.
true
if the field value has been cleared, false
otherwise.clearEventFilter()
,
EVENTFILTER
public void setEventFilter(String eventFilter)
filter
' field. The description of the 'filter
'
field is:
"If non-empty, and AllowAllEvents is false, this value is a filter expression that determines the set of events the user is allowed to view."
eventFilter
- Value to setEVENTFILTER
public void clearEventFilter()
filter
' field in the bean. The description
of the 'filter
' field is:
"If non-empty, and AllowAllEvents is false, this value is a filter expression that determines the set of events the user is allowed to view."
Using this method will not clear the server value when the bean is PUT to
the server.
Use the setEventFilterNull()
method to clear the server's value.
See the description of cleared values.
EVENTFILTER
public void setEventFilterNull()
filter
' field in the bean.
The description of the 'filter
' field is:
"If non-empty, and AllowAllEvents is false, this value is a filter expression that determines the set of events the user is allowed to view."
Using this method will clear the server value when the bean is PUT to the
server.
Use the clearEventFilter()
method to avoid clearing the server's value.
See the description of Null values.
EVENTFILTER
public boolean isAdmin()
isadmin
' field. The description of the 'isadmin
'
field is:
"If true, the user has administrator privileges."
null
).ADMIN
public boolean isAdminNull()
isadmin
' field has been set to Null or not.
The description of the 'isadmin
' field is:
"If true, the user has administrator privileges."
See the description of Null values.
true
if the field value has been marked as null, false
otherwise.setAdminNull()
,
ADMIN
public boolean isAdminClear()
isadmin
' field is clear or not. The description
of the 'isadmin
' field is:
"If true, the user has administrator privileges."
See the description of cleared values.
true
if the field value has been cleared, false
otherwise.clearAdmin()
,
ADMIN
public void setAdmin(boolean admin)
isadmin
' field. The description of the 'isadmin
'
field is:
"If true, the user has administrator privileges."
admin
- Value to setADMIN
public void clearAdmin()
isadmin
' field in the bean. The description
of the 'isadmin
' field is:
"If true, the user has administrator privileges."
Using this method will not clear the server value when the bean is PUT to
the server.
Use the setAdminNull()
method to clear the server's value.
See the description of cleared values.
ADMIN
public void setAdminNull()
isadmin
' field in the
bean. The description of the 'isadmin
' field is:
"If true, the user has administrator privileges."
Using this method will clear the server value when the bean is PUT to the
server.
Use the clearAdmin()
method to avoid clearing the server's value.
See the description of Null values.
ADMIN
public static BeanMetaData<? extends UserPermissionsBean> getBeanMetaData()
The metadata is used primarily as a parameter to a BeanTransporter
implementation''s constructor.
public UserPermissionsBean clone()
clone
in class Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |