java.lang.Object
- com.softlayer.api.Type
- - com.softlayer.api.service.Entity
  - - com.softlayer.api.service.user.permission.Role

@ApiType("SoftLayer_User_Permission_Role")
public class Role
extends Entity

See Also:: SoftLayer_User_Permission_Role

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Role.Mask

static interface Role.Service

static interface Role.ServiceAsync

Field Summary

Fields
Modifier and Type	Field	Description
`protected Account`	`account`
`protected Long`	`accountId`	A permission roles associated [[SoftLayer_Account\|customer account]] id.
`protected boolean`	`accountIdSpecified`
`protected Long`	`actionCount`	A count of
`protected List<Action>`	`actions`
`protected GregorianCalendar`	`createDate`	The date the permission role record was created.
`protected boolean`	`createDateSpecified`
`protected String`	`description`	The description of the permission role.
`protected boolean`	`descriptionSpecified`
`protected Long`	`groupCount`	A count of
`protected List<Group>`	`groups`
`protected Long`	`id`	A permission roles internal identifying number.
`protected boolean`	`idSpecified`
`protected GregorianCalendar`	`modifyDate`	The date the permission role record was last modified.
`protected boolean`	`modifyDateSpecified`
`protected String`	`name`	The name of the permission role.
`protected boolean`	`nameSpecified`
`protected Long`	`newUserDefaultFlag`	A flag showing if new users should be automatically added to this role.
`protected boolean`	`newUserDefaultFlagSpecified`
`protected Long`	`systemFlag`	A flag showing if the permission role was created by our internal system for a single user.
`protected boolean`	`systemFlagSpecified`
`protected Long`	`userCount`	A count of
`protected List<Customer>`	`users`

Fields inherited from class com.softlayer.api.Type
unknownProperties

Constructor Summary

Constructors
Constructor Description

Role()

Method Summary

Modifier and Type	Method	Description
`Role.Service`	`asService(ApiClient client)`
`Account`	`getAccount()`
`Long`	`getAccountId()`
`Long`	`getActionCount()`
`List<Action>`	`getActions()`
`GregorianCalendar`	`getCreateDate()`
`String`	`getDescription()`
`Long`	`getGroupCount()`
`List<Group>`	`getGroups()`
`Long`	`getId()`
`GregorianCalendar`	`getModifyDate()`
`String`	`getName()`
`Long`	`getNewUserDefaultFlag()`
`Long`	`getSystemFlag()`
`Long`	`getUserCount()`
`List<Customer>`	`getUsers()`
`boolean`	`isAccountIdSpecified()`
`boolean`	`isCreateDateSpecified()`
`boolean`	`isDescriptionSpecified()`
`boolean`	`isIdSpecified()`
`boolean`	`isModifyDateSpecified()`
`boolean`	`isNameSpecified()`
`boolean`	`isNewUserDefaultFlagSpecified()`
`boolean`	`isSystemFlagSpecified()`
`static Role.Service`	`service(ApiClient client)`
`static Role.Service`	`service(ApiClient client, Long id)`
`void`	`setAccount(Account account)`
`void`	`setAccountId(Long accountId)`
`void`	`setActionCount(Long actionCount)`
`void`	`setCreateDate(GregorianCalendar createDate)`
`void`	`setDescription(String description)`
`void`	`setGroupCount(Long groupCount)`
`void`	`setId(Long id)`
`void`	`setModifyDate(GregorianCalendar modifyDate)`
`void`	`setName(String name)`
`void`	`setNewUserDefaultFlag(Long newUserDefaultFlag)`
`void`	`setSystemFlag(Long systemFlag)`
`void`	`setUserCount(Long userCount)`
`void`	`unsetAccountId()`
`void`	`unsetCreateDate()`
`void`	`unsetDescription()`
`void`	`unsetId()`
`void`	`unsetModifyDate()`
`void`	`unsetName()`
`void`	`unsetNewUserDefaultFlag()`
`void`	`unsetSystemFlag()`

Methods inherited from class com.softlayer.api.Type
getUnknownProperties, setUnknownProperties

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

account
```
@ApiProperty
protected Account account
```

actions

@ApiProperty
protected List<Action> actions

groups

@ApiProperty
protected List<Group> groups

users

@ApiProperty
protected List<Customer> users

accountId
```
@ApiProperty(canBeNullOrNotSet=true)
protected Long accountId
```
A permission roles associated [[SoftLayer_Account|customer account]] id.

accountIdSpecified
```
protected boolean accountIdSpecified
```

createDate

@ApiProperty(canBeNullOrNotSet=true)
protected GregorianCalendar createDate

The date the permission role record was created.

createDateSpecified
```
protected boolean createDateSpecified
```

description

@ApiProperty(canBeNullOrNotSet=true)
protected String description

The description of the permission role.

descriptionSpecified
```
protected boolean descriptionSpecified
```

id

@ApiProperty(canBeNullOrNotSet=true)
protected Long id

A permission roles internal identifying number.

idSpecified
```
protected boolean idSpecified
```

modifyDate

@ApiProperty(canBeNullOrNotSet=true)
protected GregorianCalendar modifyDate

The date the permission role record was last modified.

modifyDateSpecified
```
protected boolean modifyDateSpecified
```

name

@ApiProperty(canBeNullOrNotSet=true)
protected String name

The name of the permission role.

nameSpecified
```
protected boolean nameSpecified
```

newUserDefaultFlag
```
@ApiProperty(canBeNullOrNotSet=true)
protected Long newUserDefaultFlag
```
A flag showing if new users should be automatically added to this role.

newUserDefaultFlagSpecified

protected boolean newUserDefaultFlagSpecified

systemFlag
```
@ApiProperty(canBeNullOrNotSet=true)
protected Long systemFlag
```
A flag showing if the permission role was created by our internal system for a single user. If this flag is set only a single user can be assigned to this permission role and it can not be deleted.

systemFlagSpecified
```
protected boolean systemFlagSpecified
```

actionCount

@ApiProperty
protected Long actionCount

A count of

groupCount
```
@ApiProperty
protected Long groupCount
```
A count of

userCount
```
@ApiProperty
protected Long userCount
```
A count of

Constructor Detail
- Role
```
public Role()
```

Method Detail

getAccount
```
public Account getAccount()
```

setAccount

public void setAccount(Account account)

getActions
```
public List<Action> getActions()
```

getGroups
```
public List<Group> getGroups()
```

getUsers
```
public List<Customer> getUsers()
```

getAccountId
```
public Long getAccountId()
```

setAccountId

public void setAccountId(Long accountId)

isAccountIdSpecified
```
public boolean isAccountIdSpecified()
```

unsetAccountId
```
public void unsetAccountId()
```

getCreateDate

public GregorianCalendar getCreateDate()

setCreateDate

public void setCreateDate(GregorianCalendar createDate)

isCreateDateSpecified

public boolean isCreateDateSpecified()

unsetCreateDate
```
public void unsetCreateDate()
```

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String description)

isDescriptionSpecified

public boolean isDescriptionSpecified()

unsetDescription
```
public void unsetDescription()
```

getId
```
public Long getId()
```

setId
```
public void setId(Long id)
```

isIdSpecified
```
public boolean isIdSpecified()
```

unsetId
```
public void unsetId()
```

getModifyDate

public GregorianCalendar getModifyDate()

setModifyDate

public void setModifyDate(GregorianCalendar modifyDate)

isModifyDateSpecified

public boolean isModifyDateSpecified()

unsetModifyDate
```
public void unsetModifyDate()
```

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

isNameSpecified
```
public boolean isNameSpecified()
```

unsetName
```
public void unsetName()
```

getNewUserDefaultFlag
```
public Long getNewUserDefaultFlag()
```

setNewUserDefaultFlag

public void setNewUserDefaultFlag(Long newUserDefaultFlag)

isNewUserDefaultFlagSpecified

public boolean isNewUserDefaultFlagSpecified()

unsetNewUserDefaultFlag
```
public void unsetNewUserDefaultFlag()
```

getSystemFlag
```
public Long getSystemFlag()
```

setSystemFlag

public void setSystemFlag(Long systemFlag)

isSystemFlagSpecified

public boolean isSystemFlagSpecified()

unsetSystemFlag
```
public void unsetSystemFlag()
```

getActionCount
```
public Long getActionCount()
```

setActionCount

public void setActionCount(Long actionCount)

getGroupCount
```
public Long getGroupCount()
```

setGroupCount

public void setGroupCount(Long groupCount)

getUserCount
```
public Long getUserCount()
```

setUserCount

public void setUserCount(Long userCount)

asService

public Role.Service asService(ApiClient client)

service

public static Role.Service service(ApiClient client)

service

public static Role.Service service(ApiClient client,
                                   Long id)

Modifier and Type	Class	Description
`static class`	`Role.Mask`
`static interface`	`Role.Service`
`static interface`	`Role.ServiceAsync`

Class Role

Nested Class Summary

Field Summary

Fields inherited from class com.softlayer.api.Type

Constructor Summary

Method Summary

Methods inherited from class com.softlayer.api.Type

Methods inherited from class java.lang.Object

Field Detail

account

actions

groups

users

accountId

accountIdSpecified

createDate

createDateSpecified

description

descriptionSpecified

id

idSpecified

modifyDate

modifyDateSpecified

name

nameSpecified

newUserDefaultFlag

newUserDefaultFlagSpecified

systemFlag

systemFlagSpecified

actionCount

groupCount

userCount

Constructor Detail

Role

Method Detail

getAccount

setAccount

getActions

getGroups

getUsers

getAccountId

setAccountId

isAccountIdSpecified

unsetAccountId

getCreateDate

setCreateDate

isCreateDateSpecified

unsetCreateDate

getDescription

setDescription

isDescriptionSpecified

unsetDescription

getId

setId

isIdSpecified

unsetId

getModifyDate

setModifyDate

isModifyDateSpecified

unsetModifyDate

getName

setName

isNameSpecified

unsetName

getNewUserDefaultFlag

setNewUserDefaultFlag

isNewUserDefaultFlagSpecified

unsetNewUserDefaultFlag

getSystemFlag

setSystemFlag

isSystemFlagSpecified

unsetSystemFlag

getActionCount

setActionCount

getGroupCount

setGroupCount

getUserCount

setUserCount

asService

service