| Local Methods | ||
Service Types | Data Object Types | All Properties | All Methods |
Methods
Methods defined in this Service |
---|
ApplicationIcon_Get, ApplicationIcon_GetByApplications, ApplicationIcon_GetInfos |
Privileges
Privilege | Description |
---|---|
POOL_VIEW | privilege is required on at-least one Application (that the ApplicationIconId represents) to get ApplicationIconInfo. |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ApplicationIcon used to make the method call. |
id | ApplicationIconId |
entityId of ApplicationIcon to get.
|
Return Value
Type | Description |
---|---|
ApplicationIconInfo | requested ApplicationIcon entity. |
Faults
Type | Description |
---|---|
EntityNotFound | Thrown if any specified entity cannot be found. |
InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
InvalidArgument | Thrown if any specified argument is invalid. |
InvalidType | Thrown if the type of any specified argument is invalid. |
UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Privileges
Privilege | Description |
---|---|
POOL_VIEW | privilege is required for each of the Applications in ApplicationId array to get the ApplicationIconInfo array. |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ApplicationIcon used to make the method call. |
height | xsd:int |
Icon height.
|
width | xsd:int |
Icon width.
|
ids | ApplicationId[] |
Array of entityId of the Applications whose ApplicationIcons
are being requested.
|
Return Value
Type | Description |
---|---|
ApplicationIconInfo[] | The array of ApplicationIcons associated with the specified Applications. The array index order matches with entityIds array. |
Faults
Type | Description |
---|---|
EntityNotFound | Thrown if any specified entity cannot be found. |
InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
InvalidArgument | Thrown if any specified argument is invalid. |
InvalidType | Thrown if the type of any specified argument is invalid. |
PartialFailureFault | Thrown if one or more Applications do not have any associated icons to select from. The PartialFailureFault contains an array of Objects. Each Object is either (a) ApplicationIconInfo for applications that have at least one icon, and thus return a matching icon or (b) EntityNotFound for applications that have no icons associated. |
UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Privileges
Privilege | Description |
---|---|
POOL_VIEW | privilege is required on at-least one Application (that each ApplicationIconId represents) to get ApplicationIconInfo. |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ApplicationIcon used to make the method call. |
ids | ApplicationIconId[] |
Array of entityId of the ApplicationIcon
|
Return Value
Type | Description |
---|---|
ApplicationIconInfo[] | The list of ApplicationIcons associated with the specified ApplicationIcon entityIDs |
Faults
Type | Description |
---|---|
EntityNotFound | Thrown if any specified entity cannot be found. |
InsufficientPermission | Thrown if the user does not have sufficient permission to perform the operation. |
InvalidArgument | Thrown if any specified argument is invalid. |
InvalidType | Thrown if the type of any specified argument is invalid. |
UnexpectedFault | Thrown if an unexpected error occurs while performing the operation. |
Top of page | Local Methods | ||
Service Types | Data Object Types | All Properties | All Methods |