com.highdeal.admin.hci
Class ServiceInfo

java.lang.Object
  extended by com.highdeal.admin.hci.ServiceInfo
All Implemented Interfaces:
java.lang.Comparable<ServiceInfo>

public class ServiceInfo
extends java.lang.Object
implements java.lang.Comparable<ServiceInfo>

This Java class represents the service information.


Nested Class Summary
static class ServiceInfo.Address
          This Java class defines the URL of an SAP CC service.
static class ServiceInfo.ServiceAvailability
          This Java class
static class ServiceInfo.ServiceInfoSecurity
          This enumeration defines the security information: off, one way, or dual.
static class ServiceInfo.ServiceInfoType
          This enumeration lists all the types of communication services.
 
Field Summary
static ServiceInfo.ServiceAvailability[] ALL_FORBIDDEN
          This service is forbidden for all the instances.
static ServiceInfo.ServiceAvailability[] ALL_MANDATORY
          This service is mandatory for all the instances in the SAP CC system.
static ServiceInfo.ServiceAvailability[] ALL_OPTIONAL
          This service is optional for all the instances.
static int NO_DEFINED_PORT
          Used if no port is defined.
static java.lang.String TAG_NAME
          The XML tag name of this class: "serviceInfo"
 
Constructor Summary
ServiceInfo()
          Builds an empty ServiceInfo instance.
ServiceInfo(ServiceInfo.ServiceInfoType serviceInfoType)
           
 
Method Summary
 int compareTo(ServiceInfo o)
           
 ServiceInfo.Address getAddress()
           
 ServiceInfo.ServiceInfoSecurity getServiceInfoSecurity()
           
 ServiceInfo.ServiceInfoType getServiceInfoType()
           
 java.net.URL getURL()
          Returns the URL of the service.
 boolean isAvailable()
          Indicates if the service is available, i.e.
 boolean isEnabled()
          Indicates if the service is enabled, i.e.
 void setServiceInfoSecurity(ServiceInfo.ServiceInfoSecurity serviceInfoSecurity)
           
 void setServiceInfoType(ServiceInfo.ServiceInfoType serviceInfoType)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TAG_NAME

public static final java.lang.String TAG_NAME
The XML tag name of this class: "serviceInfo"

See Also:
Constant Field Values

NO_DEFINED_PORT

public static final int NO_DEFINED_PORT
Used if no port is defined.

See Also:
Constant Field Values

ALL_MANDATORY

public static final ServiceInfo.ServiceAvailability[] ALL_MANDATORY
This service is mandatory for all the instances in the SAP CC system.


ALL_OPTIONAL

public static final ServiceInfo.ServiceAvailability[] ALL_OPTIONAL
This service is optional for all the instances.


ALL_FORBIDDEN

public static final ServiceInfo.ServiceAvailability[] ALL_FORBIDDEN
This service is forbidden for all the instances.

Constructor Detail

ServiceInfo

public ServiceInfo()
Builds an empty ServiceInfo instance.


ServiceInfo

public ServiceInfo(ServiceInfo.ServiceInfoType serviceInfoType)
Method Detail

getServiceInfoType

public ServiceInfo.ServiceInfoType getServiceInfoType()

setServiceInfoType

public void setServiceInfoType(ServiceInfo.ServiceInfoType serviceInfoType)

getServiceInfoSecurity

public ServiceInfo.ServiceInfoSecurity getServiceInfoSecurity()

setServiceInfoSecurity

public void setServiceInfoSecurity(ServiceInfo.ServiceInfoSecurity serviceInfoSecurity)

getAddress

public ServiceInfo.Address getAddress()

isEnabled

public boolean isEnabled()
Indicates if the service is enabled, i.e. it is defined.

Returns:
true if service is enabled, false otherwise

isAvailable

public boolean isAvailable()
Indicates if the service is available, i.e. it is possible to enable it.

Returns:
true if service is available, false otherwise

getURL

public java.net.URL getURL()
Returns the URL of the service.

Returns:
The URL of the service if it is available, null otherwise

compareTo

public int compareTo(ServiceInfo o)
Specified by:
compareTo in interface java.lang.Comparable<ServiceInfo>

Document Published: October 2015 (SAP CC 4.0 SP10 and Later)