http://www.ibm.com/schema/twss/spm/admin/type/v2_0/interface
The TypeAdministrationInterface Port Type

Type administration interface. This interface allows an administrator to create, update, retrieve, and delete types in the service policy manager system. Types are used for validating the form factor of policy attribute values. They do not assign any semantics or meaning to the contents of the value, but instead ensure that the value is of the right "form" for a corresponding type.

As removing a type can potentially be a dangerous operation, removal of a type is only allowed provided there are no existing policy attributes in the system that have been assigned to that type.

 Collapse Operations
TypeAdministrationInterface_createPolicyTypeResponse  createPolicyType (createPolicyTypeRequest request) [faults:  ServicePolicyException  ]

Creates a new policy type in the service policy manager. The type name must be unique across all types defined in the system. Both the editable and editMask fields must be present during creation of the type definition. The editMask may need to be sent as CDATA in order to pass the regular expression content.

Input: TypeAdministrationInterface_createPolicyTypeRequest

Create policy type operation input parameters. Specifies the type definition to create in the service policy manager. Both editable and editMask fields must be present.

Output: TypeAdministrationInterface_createPolicyTypeResponse

Create policy type response result. Contains empty content.

Fault:
ServicePolicyException  : 

Raised if an invalid type defintion is specified, if the type already exists, or if an internal error occurs.


TypeAdministrationInterface_getAllPolicyTypesResponse  getAllPolicyTypes (getAllPolicyTypesRequest request) [faults:  ServicePolicyException  ]

Retrieve all the policy type definitions from the service policy manager system.

Input: TypeAdministrationInterface_getAllPolicyTypesRequest

Get all policy types operation input parameters. Contains empty content.

Output: TypeAdministrationInterface_getAllPolicyTypesResponse

Get all policy types response result. Returns a list of all policy definitions in the service policy manager system.

Fault:
ServicePolicyException  : 

Raised if an internal error occurs.


TypeAdministrationInterface_getPolicyTypeResponse  getPolicyType (getPolicyTypeRequest request) [faults:  ServicePolicyException  ]

Gets the policy type definition for the supplied type name.

Input: TypeAdministrationInterface_getPolicyTypeRequest

Get policy type operation input parameters. Specifies the type name whose definition to fetch.

Output: TypeAdministrationInterface_getPolicyTypeResponse

Get policy type response result. Returns the policy type definition for the supplied type name.

Fault:
ServicePolicyException  : 

Raised if the supplied type name does not exist, or if an internal error occurs.


TypeAdministrationInterface_removePolicyTypeResponse  removePolicyType (removePolicyTypeRequest request) [faults:  ServicePolicyException  ]

Removes a policy type from the service policy manager. Due to the dangerous nature of this operation, this operation will not be allowed to succeed provided there are existing policy attribute values in the system that reference this type. Those policy attributes must be removed from the system before this operation can succeed.

Input: TypeAdministrationInterface_removePolicyTypeRequest

Remove policy type operation input parameters. Specifies the name of the policy type definition to remove from the service policy manager system.

Output: TypeAdministrationInterface_removePolicyTypeResponse

Remove policy type response result. Contains empty content.

Fault:
ServicePolicyException  : 

Raised if the specified policy type is still in use by the system, if the specified type does not exist, or if an internal error occurs.


TypeAdministrationInterface_updatePolicyTypeResponse  updatePolicyType (updatePolicyTypeRequest request) [faults:  ServicePolicyException  ]

Updates the specified policy type definition. Only changed fields are updated in the system. Omitted optional fields are considered not to have changed.

Note: this is a potentially dangerous operation for policy values that are already in use in the system. Thus, any changes to policy values should be made with extreme caution.

Input: TypeAdministrationInterface_updatePolicyTypeRequest

Update policy type operation input parameters. The supplied definition will be updated in the service policy manager system.

Output: TypeAdministrationInterface_updatePolicyTypeResponse

Update policy type response result. Contains empty content.

Fault:
ServicePolicyException  : 

Raised if the specified policy type does not exist, if an invalid change is made, or if an internal error occurs.


 Collapse XML
-<wsdl:portType  name="TypeAdministrationInterface">
-<wsdl:documentation>
<xhtml:p>Type administration interface. This interface allows an administrator to create, update, retrieve, and delete types in the service policy manager system. Types are used for validating the form factor of policy attribute values. They do not assign any semantics or meaning to the contents of the value, but instead ensure that the value is of the right "form" for a corresponding type.</xhtml:p>
<xhtml:p>As removing a type can potentially be a dangerous operation, removal of a type is only allowed provided there are no existing policy attributes in the system that have been assigned to that type.</xhtml:p>
</wsdl:documentation>
-<wsdl:operation  name="createPolicyType">
-<wsdl:documentation>
<xhtml:p>Creates a new policy type in the service policy manager. The type name must be unique across all types defined in the system. Both the editable and editMask fields must be present during creation of the type definition. The editMask may need to be sent as CDATA in order to pass the regular expression content.</xhtml:p>
</wsdl:documentation>
-<wsdl:documentation>
<xhtml:p>Create policy type operation input parameters. Specifies the type definition to create in the service policy manager. Both editable and editMask fields must be present.</xhtml:p>
</wsdl:documentation>
</wsdl:input>
-<wsdl:documentation>
<xhtml:p>Create policy type response result. Contains empty content.</xhtml:p>
</wsdl:documentation>
</wsdl:output>
-<wsdl:fault  message="admin_type_interface:ServicePolicyException"  name="ServicePolicyException">
-<wsdl:documentation>
<xhtml:p>Raised if an invalid type defintion is specified, if the type already exists, or if an internal error occurs.</xhtml:p>
</wsdl:documentation>
</wsdl:fault>
</wsdl:operation>
-<wsdl:operation  name="updatePolicyType">
-<wsdl:documentation>
<xhtml:p>Updates the specified policy type definition. Only changed fields are updated in the system. Omitted optional fields are considered not to have changed.</xhtml:p>
<xhtml:p>Note: this is a potentially dangerous operation for policy values that are already in use in the system. Thus, any changes to policy values should be made with extreme caution.</xhtml:p>
</wsdl:documentation>
-<wsdl:documentation>
<xhtml:p>Update policy type operation input parameters. The supplied definition will be updated in the service policy manager system.</xhtml:p>
</wsdl:documentation>
</wsdl:input>
-<wsdl:documentation>
<xhtml:p>Update policy type response result. Contains empty content.</xhtml:p>
</wsdl:documentation>
</wsdl:output>
-<wsdl:fault  message="admin_type_interface:ServicePolicyException"  name="ServicePolicyException">
-<wsdl:documentation>
<xhtml:p>Raised if the specified policy type does not exist, if an invalid change is made, or if an internal error occurs.</xhtml:p>
</wsdl:documentation>
</wsdl:fault>
</wsdl:operation>
-<wsdl:operation  name="getPolicyType">
-<wsdl:documentation>
<xhtml:p>Gets the policy type definition for the supplied type name.</xhtml:p>
</wsdl:documentation>
-<wsdl:documentation>
<xhtml:p>Get policy type operation input parameters. Specifies the type name whose definition to fetch.</xhtml:p>
</wsdl:documentation>
</wsdl:input>
-<wsdl:documentation>
<xhtml:p>Get policy type response result. Returns the policy type definition for the supplied type name.</xhtml:p>
</wsdl:documentation>
</wsdl:output>
-<wsdl:fault  message="admin_type_interface:ServicePolicyException"  name="ServicePolicyException">
-<wsdl:documentation>
<xhtml:p>Raised if the supplied type name does not exist, or if an internal error occurs.</xhtml:p>
</wsdl:documentation>
</wsdl:fault>
</wsdl:operation>
-<wsdl:operation  name="removePolicyType">
-<wsdl:documentation>
<xhtml:p>Removes a policy type from the service policy manager. Due to the dangerous nature of this operation, this operation will not be allowed to succeed provided there are existing policy attribute values in the system that reference this type. Those policy attributes must be removed from the system before this operation can succeed.</xhtml:p>
</wsdl:documentation>
-<wsdl:documentation>
<xhtml:p>Remove policy type operation input parameters. Specifies the name of the policy type definition to remove from the service policy manager system.</xhtml:p>
</wsdl:documentation>
</wsdl:input>
-<wsdl:documentation>
<xhtml:p>Remove policy type response result. Contains empty content.</xhtml:p>
</wsdl:documentation>
</wsdl:output>
-<wsdl:fault  message="admin_type_interface:ServicePolicyException"  name="ServicePolicyException">
-<wsdl:documentation>
<xhtml:p>Raised if the specified policy type is still in use by the system, if the specified type does not exist, or if an internal error occurs.</xhtml:p>
</wsdl:documentation>
</wsdl:fault>
</wsdl:operation>
-<wsdl:operation  name="getAllPolicyTypes">
-<wsdl:documentation>
<xhtml:p>Retrieve all the policy type definitions from the service policy manager system.</xhtml:p>
</wsdl:documentation>
-<wsdl:documentation>
<xhtml:p>Get all policy types operation input parameters. Contains empty content.</xhtml:p>
</wsdl:documentation>
</wsdl:input>
-<wsdl:documentation>
<xhtml:p>Get all policy types response result. Returns a list of all policy definitions in the service policy manager system.</xhtml:p>
</wsdl:documentation>
</wsdl:output>
-<wsdl:fault  message="admin_type_interface:ServicePolicyException"  name="ServicePolicyException">
-<wsdl:documentation>
<xhtml:p>Raised if an internal error occurs.</xhtml:p>
</wsdl:documentation>
</wsdl:fault>
</wsdl:operation>
</wsdl:portType>
 Collapse Used-By
Service Port Binding
TypeAdministrationService TypeAdministrationService TypeAdministrationInterfaceBinding
Generated by WSDLdoc ©