Class UserServicePermission
- java.lang.Object
-
- com.orchestranetworks.userservice.permission.UserServicePermission
-
public final class UserServicePermission extends Object
Defines the permission for whether or not a user can display or execute a user service.The possible states are:
- enabled – the service is displayed or can be executed;
- disabled – the service is not displayed or cannot be executed;
- Since:
- 5.8.0
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static UserServicePermissiongetDisabled()Factory method that specifies that a user service can not be displayed or executed in the current session context.static UserServicePermissiongetDisabled(UserMessage aReason)Factory method that specifies that a user service can not be displayed or executed in the current session context.UserMessagegetDisabledReason()Only defined if this state is set to 'disabled' and a specific reason is provided.static UserServicePermissiongetEnabled()Factory method that specifies that a user service can be displayed or executed in the current session context.chargetFlag()Persistent flag that identifies the permission.StringgetFlagString()Persistent flag that identifies the permission.booleanisDisabled()booleanisEnabled()booleanisSameFlag(String aFlagString)Returnstrueif the flag specified is the same as the flag of this permission.UserServicePermissionmax(UserServicePermission anotherPermission)Returns the least restrictive permission between this instance and the instance given as an argument.UserServicePermissionmin(UserServicePermission anotherPermission)Returns the most restrictive permission between this instance and the instance given as an argument.static UserServicePermissionparseFlag(char accessFlag)Factory method.static UserServicePermissionparseFlag(String actionFlag)Factory method.StringtoDisplayString(Locale aLocale)StringtoString()
-
-
-
Method Detail
-
getEnabled
public static UserServicePermission getEnabled()
Factory method that specifies that a user service can be displayed or executed in the current session context.
-
getDisabled
public static UserServicePermission getDisabled()
Factory method that specifies that a user service can not be displayed or executed in the current session context. This method does not provide a reason for this restriction. To specify a reason, use thegetDisabled(UserMessage)method.
-
getDisabled
public static UserServicePermission getDisabled(UserMessage aReason)
Factory method that specifies that a user service can not be displayed or executed in the current session context. This method allows to provide a reason for this restriction.
-
isEnabled
public boolean isEnabled()
- See Also:
getEnabled()
-
isDisabled
public boolean isDisabled()
- See Also:
getDisabled(),getDisabled(UserMessage)
-
getDisabledReason
public UserMessage getDisabledReason()
Only defined if this state is set to 'disabled' and a specific reason is provided.- See Also:
getDisabled(UserMessage)
-
parseFlag
public static UserServicePermission parseFlag(String actionFlag)
Factory method. The argument specified can be obtained by calling the methodgetFlagString().
-
parseFlag
public static UserServicePermission parseFlag(char accessFlag)
Factory method. The argument specified can be obtained by calling the methodgetFlagString().
-
getFlag
public char getFlag()
Persistent flag that identifies the permission.
-
getFlagString
public String getFlagString()
Persistent flag that identifies the permission.It returns the same content as
getFlag().
-
isSameFlag
public boolean isSameFlag(String aFlagString)
Returnstrueif the flag specified is the same as the flag of this permission.
-
min
public UserServicePermission min(UserServicePermission anotherPermission)
Returns the most restrictive permission between this instance and the instance given as an argument.
-
max
public UserServicePermission max(UserServicePermission anotherPermission)
Returns the least restrictive permission between this instance and the instance given as an argument.
-
-