com.ibm.itim.remoteservices.provider

Class ServiceProviderInfoOperation

  • java.lang.Object
    • com.ibm.itim.remoteservices.provider.ServiceProviderInfoOperation
  • All Implemented Interfaces:
    ServiceDefConstants


    public class ServiceProviderInfoOperation
    extends java.lang.Object
    implements ServiceDefConstants
    A holder object for tag sets in service.def.
    • Constructor Detail

      • ServiceProviderInfoOperation

        public ServiceProviderInfoOperation()
    • Method Detail

      • setName

        public void setName(java.lang.String name)
        Sets this ServiceDefOperation's name, or the cn attribute of an operation tag in service.def.
        Parameters:
        name - name of this service def operation
      • getName

        public java.lang.String getName()
        Returns the OperationDescriptor name.
        Returns:
        the OperationDescriptor name
      • addOperation

        public void addOperation(java.lang.String operationName)
        Adds an operation name to this ServiceDefOperation.
        Parameters:
        operationName - operation name
      • getOperations

        public java.util.Collection<java.lang.String> getOperations()
        Returns this ServiceDefOperation's operation names
        Returns:
        Collection of String operation names
      • addParameter

        public void addParameter(ServiceProviderInfoParameter parameter)
        Adds a ServiceProviderInfoParameter to this ServiceDefOperation.
        Parameters:
        parameter - parameter to add
      • getParameter

        public ServiceProviderInfoParameter getParameter(java.lang.String paramName)
        Returns this OperationDescriptor's specified parameter
        Parameters:
        paramName - parameter (attribute) name
        Returns:
        ServiceProviderInfoParameter / null if not found
      • getParameters

        public java.util.Map<java.lang.String,ServiceProviderInfoParameter> getParameters()
        Returns this OperationDescriptor's parameters
        Returns:
        Collection of ServiceProviderInfoParameter objects (never null, may be empty)
      • addInput

        public void addInput(java.lang.String attrName,
                             java.lang.String source)
        Adds an input name and source to this ServiceDefOperation's inputs Map.
        Parameters:
        attrName - input attribute name
        source - source attribute name
      • getInputs

        public java.util.Map<java.lang.String,java.lang.String> getInputs()
        Returns this OperationDescriptor's inputs.
        Returns:
        Map of imputs, with key = attribute name, value = source attribute name
      • setAssemblyLineLocation

        public void setAssemblyLineLocation(java.lang.String assemblyLineLocation)
        Sets this ServiceDefOperation's assemblyLineLocation attribute.
        Parameters:
        assemblyLineLocation - Assembly Line Location attribute value
      • getAssemblyLineLocation

        public java.lang.String getAssemblyLineLocation()
        Gets this ServiceDefOperation's assemblyLineLocation attribute.
        Returns:
        Assembly Line Location attribute value
      • getRequiredAttributes

        public java.util.Set<java.lang.String> getRequiredAttributes(java.lang.String source)
        Returns this OperationDescriptor's required attributes Set for specified source.
        Parameters:
        source - source (one of SOURCE_ACCOUNT, SOURCE_SERVICE, or null indicating any)
        Returns:
        Set of String attribute names (lower cased)
      • isRequiredServiceAttribute

        public boolean isRequiredServiceAttribute(java.lang.String attrName)
        Returns whether specified attribute name is in OperationDescriptor's required attributes Set.
        Parameters:
        attrName - name of attribute
        Returns:
        true if attribute is a required service attribute
      • isRequiredAccountAttribute

        public boolean isRequiredAccountAttribute(java.lang.String attrName)
        Returns whether specified attribute name is in OperationDescriptor's required attributes Set.
        Parameters:
        attrName - name of attribute
        Returns:
        true if attribute is a required account attribute
      • isRequiredAttribute

        public boolean isRequiredAttribute(java.lang.String attrName,
                                           com.ibm.itim.remoteservices.provider.EntityUtil.EntityType sourceType)
        Returns whether specified attribute name is in OperationDescriptor's required attributes.
        Parameters:
        attrName - name of attribute
        Returns:
        true if attribute is a required attribute of the source type
      • addSendOnlyAttribute

        public void addSendOnlyAttribute(java.lang.String attrName)
        Adds a send-only attribute name to this ServiceDefOperation's send-only attributes Set.
        Parameters:
        attrName - name of attribute
      • getSendOnlyAttributes

        public java.util.Set<java.lang.String> getSendOnlyAttributes()
        Returns this OperationDescriptor's send-only attributes Set.
        Returns:
        Set of String attribute names (lower cased)
      • isSendOnlyAttribute

        public boolean isSendOnlyAttribute(java.lang.String attrName)
        Returns whether specified attribute name is in OperationDescriptor's send-only attributes Set.
        Parameters:
        attrName - name of attribute
        Returns:
        true if attribute is a send-only attribute
      • addReplaceMultiValueAttribute

        public void addReplaceMultiValueAttribute(java.lang.String attrName)
        Adds a replace-multi-value attribute name to this ServiceDefOperation's replace-multi-value attributes Set.
        Parameters:
        attrName - name of attribute
      • getReplaceMultiValueAttributes

        public java.util.Set<java.lang.String> getReplaceMultiValueAttributes()
        Returns this OperationDescriptor's replace-multi-value attributes Set.
        Returns:
        Set of String attribute names (lower cased)
      • isReplaceMultiValueAttribute

        public boolean isReplaceMultiValueAttribute(java.lang.String attrName)
        Returns whether specified attribute name is in OperationDescriptor's replace-multi-value attributes Set.
        Parameters:
        attrName - name of attribute
        Returns:
        true if attribute is a replace-multi-value attribute
      • isAddDeleteSingleValueAttribute

        public boolean isAddDeleteSingleValueAttribute(java.lang.String attrName)
        Returns whether specified attribute name is in OperationDescriptor's add-delete-single-value attributes Set.
        Parameters:
        attrName - name of attribute
        Returns:
        true if attribute is an add-delete-single-value attribute
      • toXML

        public java.lang.String toXML()
        Returns tags parsed from service.def.