BlackBerry Administration API
v5.0.3.29

com.rim.bes.bas.dto
Class ServiceInstanceType

Package class diagram package ServiceInstanceType
java.lang.Object
  extended by com.rim.bes.bas.dto.BASBaseDTO
      extended by com.rim.bes.bas.dto.ServiceInstanceType
Direct Known Subclasses:
ActiveDirectoryServiceInstanceType, AlertCoreServiceInstanceType, AlertHostServiceInstanceType, AscendentServiceInstanceType, AttachmentConnectorServiceInstanceType, AttachmentServerServiceInstanceType, BASCoreServiceInstanceType, BASHostServiceInstanceType, CollaborationServiceInstanceType, ControllerServiceInstanceType, DispatcherCoreServiceInstanceType, DispatcherHostServiceInstanceType, EmailAgentServiceInstanceType, EmailCoreServiceInstanceType, EmailHostServiceInstanceType, IMCollaborationServiceInstanceType, LoggingServiceInstanceType, MDSCSServiceInstanceType, MDSSCoreServiceInstanceType, MDSSHostServiceInstanceType, PolicyCoreServiceInstanceType, PolicyHostServiceInstanceType, RouterServiceInstanceType, ServiceInstance, SIPServiceInstanceType, SynchronizationCoreServiceInstanceType, SynchronizationHostServiceInstanceType

public abstract class ServiceInstanceType
extends BASBaseDTO

Java class for ServiceInstanceType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ServiceInstanceType">
   <complexContent>
     <extension base="{http://www.rim.com/com.rim.bes.bas.dto}BASBaseDTO">
       <sequence>
         <element name="installationState" type="{http://www.rim.com/com.rim.bes.bas.dto}ServiceInstanceInstallationStateEnumType" minOccurs="0"/>
         <element name="status" type="{http://www.rim.com/com.rim.bes.bas.dto}ServiceInstanceStatusEnumType" minOccurs="0"/>
         <element name="canBeDeletedDirectly" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="canBeDeletedOnServerDelete" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="childServiceInstanceAssociation" type="{http://www.w3.org/2001/XMLSchema}int" maxOccurs="unbounded" minOccurs="0"/>
         <element name="extendedDataLoaded" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="installedMachine" type="{http://www.rim.com/com.rim.bes.bas.dto}ServerType" minOccurs="0"/>
         <element name="installedPort" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="isHidden" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="localeNameAndDescription" type="{http://www.rim.com/applicationattributes}LocaleNameAndDescription" maxOccurs="unbounded" minOccurs="0"/>
         <element name="name" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="parentServiceInstanceAssociation" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="plugInId" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="reference" type="{http://www.rim.com/com.rim.bes.bas.dto}Reference" maxOccurs="unbounded" minOccurs="0"/>
         <element name="serviceConsumers" type="{http://www.rim.com/com.rim.bes.bas.dto}ServiceInstanceRelationshipType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="serviceHasSettings" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="serviceId" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="serviceInstanceId" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="serviceProducers" type="{http://www.rim.com/com.rim.bes.bas.dto}ServiceInstanceRelationshipType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="statusName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="type" type="{http://www.w3.org/2001/XMLSchema}int" minOccurs="0"/>
         <element name="version" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 


Nested Class Summary
 
Nested classes/interfaces inherited from class com.rim.bes.bas.dto.BASBaseDTO
BASBaseDTO.VersionStamps
 
Field Summary
protected  java.lang.Boolean canBeDeletedDirectly
           
protected  java.lang.Boolean canBeDeletedOnServerDelete
           
protected  java.util.List<java.lang.Integer> childServiceInstanceAssociation
           
protected  java.lang.Boolean extendedDataLoaded
           
protected  ServiceInstanceInstallationStateEnumType installationState
           
protected  ServerType installedMachine
           
protected  java.lang.Integer installedPort
           
protected  java.lang.Boolean isHidden
           
protected  java.util.List<LocaleNameAndDescription> localeNameAndDescription
           
protected  java.lang.String name
           
protected  java.lang.Integer parentServiceInstanceAssociation
           
protected  java.lang.Integer plugInId
           
protected  java.util.List<Reference> reference
           
protected  java.util.List<ServiceInstanceRelationshipType> serviceConsumers
           
protected  java.lang.Boolean serviceHasSettings
           
protected  java.lang.Integer serviceId
           
protected  java.lang.Integer serviceInstanceId
           
protected  java.util.List<ServiceInstanceRelationshipType> serviceProducers
           
protected  ServiceInstanceStatusEnumType status
           
protected  java.lang.String statusName
           
protected  java.lang.Integer type
           
protected  java.lang.String version
           
 
Fields inherited from class com.rim.bes.bas.dto.BASBaseDTO
versionStamps
 
Constructor Summary
ServiceInstanceType()
           
 
Method Summary
 java.util.List<java.lang.Integer> getChildServiceInstanceAssociation()
          Gets the value of the childServiceInstanceAssociation property.
 ServiceInstanceInstallationStateEnumType getInstallationState()
          Gets the value of the installationState property.
 ServerType getInstalledMachine()
          Gets the value of the installedMachine property.
 java.lang.Integer getInstalledPort()
          Gets the value of the installedPort property.
 java.util.List<LocaleNameAndDescription> getLocaleNameAndDescription()
          Gets the value of the localeNameAndDescription property.
 java.lang.String getName()
          Gets the value of the name property.
 java.lang.Integer getParentServiceInstanceAssociation()
          Gets the value of the parentServiceInstanceAssociation property.
 java.lang.Integer getPlugInId()
          Gets the value of the plugInId property.
 java.util.List<Reference> getReference()
          Gets the value of the reference property.
 java.util.List<ServiceInstanceRelationshipType> getServiceConsumers()
          Gets the value of the serviceConsumers property.
 java.lang.Integer getServiceId()
          Gets the value of the serviceId property.
 java.lang.Integer getServiceInstanceId()
          Gets the value of the serviceInstanceId property.
 java.util.List<ServiceInstanceRelationshipType> getServiceProducers()
          Gets the value of the serviceProducers property.
 ServiceInstanceStatusEnumType getStatus()
          Gets the value of the status property.
 java.lang.String getStatusName()
          Gets the value of the statusName property.
 java.lang.Integer getType()
          Gets the value of the type property.
 java.lang.String getVersion()
          Gets the value of the version property.
 java.lang.Boolean isCanBeDeletedDirectly()
          Gets the value of the canBeDeletedDirectly property.
 java.lang.Boolean isCanBeDeletedOnServerDelete()
          Gets the value of the canBeDeletedOnServerDelete property.
 java.lang.Boolean isExtendedDataLoaded()
          Gets the value of the extendedDataLoaded property.
 java.lang.Boolean isIsHidden()
          Gets the value of the isHidden property.
 java.lang.Boolean isServiceHasSettings()
          Gets the value of the serviceHasSettings property.
 void setCanBeDeletedDirectly(java.lang.Boolean value)
          Sets the value of the canBeDeletedDirectly property.
 void setCanBeDeletedOnServerDelete(java.lang.Boolean value)
          Sets the value of the canBeDeletedOnServerDelete property.
 void setExtendedDataLoaded(java.lang.Boolean value)
          Sets the value of the extendedDataLoaded property.
 void setInstallationState(ServiceInstanceInstallationStateEnumType value)
          Sets the value of the installationState property.
 void setInstalledMachine(ServerType value)
          Sets the value of the installedMachine property.
 void setInstalledPort(java.lang.Integer value)
          Sets the value of the installedPort property.
 void setIsHidden(java.lang.Boolean value)
          Sets the value of the isHidden property.
 void setName(java.lang.String value)
          Sets the value of the name property.
 void setParentServiceInstanceAssociation(java.lang.Integer value)
          Sets the value of the parentServiceInstanceAssociation property.
 void setPlugInId(java.lang.Integer value)
          Sets the value of the plugInId property.
 void setServiceHasSettings(java.lang.Boolean value)
          Sets the value of the serviceHasSettings property.
 void setServiceId(java.lang.Integer value)
          Sets the value of the serviceId property.
 void setServiceInstanceId(java.lang.Integer value)
          Sets the value of the serviceInstanceId property.
 void setStatus(ServiceInstanceStatusEnumType value)
          Sets the value of the status property.
 void setStatusName(java.lang.String value)
          Sets the value of the statusName property.
 void setType(java.lang.Integer value)
          Sets the value of the type property.
 void setVersion(java.lang.String value)
          Sets the value of the version property.
 
Methods inherited from class com.rim.bes.bas.dto.BASBaseDTO
getVersionStamps, setVersionStamps
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

installationState

protected ServiceInstanceInstallationStateEnumType installationState

status

protected ServiceInstanceStatusEnumType status

canBeDeletedDirectly

protected java.lang.Boolean canBeDeletedDirectly

canBeDeletedOnServerDelete

protected java.lang.Boolean canBeDeletedOnServerDelete

childServiceInstanceAssociation

protected java.util.List<java.lang.Integer> childServiceInstanceAssociation

extendedDataLoaded

protected java.lang.Boolean extendedDataLoaded

installedMachine

protected ServerType installedMachine

installedPort

protected java.lang.Integer installedPort

isHidden

protected java.lang.Boolean isHidden

localeNameAndDescription

protected java.util.List<LocaleNameAndDescription> localeNameAndDescription

name

protected java.lang.String name

parentServiceInstanceAssociation

protected java.lang.Integer parentServiceInstanceAssociation

plugInId

protected java.lang.Integer plugInId

reference

protected java.util.List<Reference> reference

serviceConsumers

protected java.util.List<ServiceInstanceRelationshipType> serviceConsumers

serviceHasSettings

protected java.lang.Boolean serviceHasSettings

serviceId

protected java.lang.Integer serviceId

serviceInstanceId

protected java.lang.Integer serviceInstanceId

serviceProducers

protected java.util.List<ServiceInstanceRelationshipType> serviceProducers

statusName

protected java.lang.String statusName

type

protected java.lang.Integer type

version

protected java.lang.String version
Constructor Detail

ServiceInstanceType

public ServiceInstanceType()
Method Detail

getInstallationState

public ServiceInstanceInstallationStateEnumType getInstallationState()
Gets the value of the installationState property.

Returns:
possible object is ServiceInstanceInstallationStateEnumType

setInstallationState

public void setInstallationState(ServiceInstanceInstallationStateEnumType value)
Sets the value of the installationState property.

Parameters:
value - allowed object is ServiceInstanceInstallationStateEnumType

getStatus

public ServiceInstanceStatusEnumType getStatus()
Gets the value of the status property.

Returns:
possible object is ServiceInstanceStatusEnumType

setStatus

public void setStatus(ServiceInstanceStatusEnumType value)
Sets the value of the status property.

Parameters:
value - allowed object is ServiceInstanceStatusEnumType

isCanBeDeletedDirectly

public java.lang.Boolean isCanBeDeletedDirectly()
Gets the value of the canBeDeletedDirectly property.

Returns:
possible object is Boolean

setCanBeDeletedDirectly

public void setCanBeDeletedDirectly(java.lang.Boolean value)
Sets the value of the canBeDeletedDirectly property.

Parameters:
value - allowed object is Boolean

isCanBeDeletedOnServerDelete

public java.lang.Boolean isCanBeDeletedOnServerDelete()
Gets the value of the canBeDeletedOnServerDelete property.

Returns:
possible object is Boolean

setCanBeDeletedOnServerDelete

public void setCanBeDeletedOnServerDelete(java.lang.Boolean value)
Sets the value of the canBeDeletedOnServerDelete property.

Parameters:
value - allowed object is Boolean

getChildServiceInstanceAssociation

public java.util.List<java.lang.Integer> getChildServiceInstanceAssociation()
Gets the value of the childServiceInstanceAssociation property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the childServiceInstanceAssociation property.

For example, to add a new item, do as follows:

    getChildServiceInstanceAssociation().add(newItem);
 

Objects of the following type(s) are allowed in the list Integer


isExtendedDataLoaded

public java.lang.Boolean isExtendedDataLoaded()
Gets the value of the extendedDataLoaded property.

Returns:
possible object is Boolean

setExtendedDataLoaded

public void setExtendedDataLoaded(java.lang.Boolean value)
Sets the value of the extendedDataLoaded property.

Parameters:
value - allowed object is Boolean

getInstalledMachine

public ServerType getInstalledMachine()
Gets the value of the installedMachine property.

Returns:
possible object is ServerType

setInstalledMachine

public void setInstalledMachine(ServerType value)
Sets the value of the installedMachine property.

Parameters:
value - allowed object is ServerType

getInstalledPort

public java.lang.Integer getInstalledPort()
Gets the value of the installedPort property.

Returns:
possible object is Integer

setInstalledPort

public void setInstalledPort(java.lang.Integer value)
Sets the value of the installedPort property.

Parameters:
value - allowed object is Integer

isIsHidden

public java.lang.Boolean isIsHidden()
Gets the value of the isHidden property.

Returns:
possible object is Boolean

setIsHidden

public void setIsHidden(java.lang.Boolean value)
Sets the value of the isHidden property.

Parameters:
value - allowed object is Boolean

getLocaleNameAndDescription

public java.util.List<LocaleNameAndDescription> getLocaleNameAndDescription()
Gets the value of the localeNameAndDescription property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the localeNameAndDescription property.

For example, to add a new item, do as follows:

    getLocaleNameAndDescription().add(newItem);
 

Objects of the following type(s) are allowed in the list LocaleNameAndDescription


getName

public java.lang.String getName()
Gets the value of the name property.

Returns:
possible object is String

setName

public void setName(java.lang.String value)
Sets the value of the name property.

Parameters:
value - allowed object is String

getParentServiceInstanceAssociation

public java.lang.Integer getParentServiceInstanceAssociation()
Gets the value of the parentServiceInstanceAssociation property.

Returns:
possible object is Integer

setParentServiceInstanceAssociation

public void setParentServiceInstanceAssociation(java.lang.Integer value)
Sets the value of the parentServiceInstanceAssociation property.

Parameters:
value - allowed object is Integer

getPlugInId

public java.lang.Integer getPlugInId()
Gets the value of the plugInId property.

Returns:
possible object is Integer

setPlugInId

public void setPlugInId(java.lang.Integer value)
Sets the value of the plugInId property.

Parameters:
value - allowed object is Integer

getReference

public java.util.List<Reference> getReference()
Gets the value of the reference property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the reference property.

For example, to add a new item, do as follows:

    getReference().add(newItem);
 

Objects of the following type(s) are allowed in the list Reference


getServiceConsumers

public java.util.List<ServiceInstanceRelationshipType> getServiceConsumers()
Gets the value of the serviceConsumers property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the serviceConsumers property.

For example, to add a new item, do as follows:

    getServiceConsumers().add(newItem);
 

Objects of the following type(s) are allowed in the list ServiceInstanceRelationshipType


isServiceHasSettings

public java.lang.Boolean isServiceHasSettings()
Gets the value of the serviceHasSettings property.

Returns:
possible object is Boolean

setServiceHasSettings

public void setServiceHasSettings(java.lang.Boolean value)
Sets the value of the serviceHasSettings property.

Parameters:
value - allowed object is Boolean

getServiceId

public java.lang.Integer getServiceId()
Gets the value of the serviceId property.

Returns:
possible object is Integer

setServiceId

public void setServiceId(java.lang.Integer value)
Sets the value of the serviceId property.

Parameters:
value - allowed object is Integer

getServiceInstanceId

public java.lang.Integer getServiceInstanceId()
Gets the value of the serviceInstanceId property.

Returns:
possible object is Integer

setServiceInstanceId

public void setServiceInstanceId(java.lang.Integer value)
Sets the value of the serviceInstanceId property.

Parameters:
value - allowed object is Integer

getServiceProducers

public java.util.List<ServiceInstanceRelationshipType> getServiceProducers()
Gets the value of the serviceProducers property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the serviceProducers property.

For example, to add a new item, do as follows:

    getServiceProducers().add(newItem);
 

Objects of the following type(s) are allowed in the list ServiceInstanceRelationshipType


getStatusName

public java.lang.String getStatusName()
Gets the value of the statusName property.

Returns:
possible object is String

setStatusName

public void setStatusName(java.lang.String value)
Sets the value of the statusName property.

Parameters:
value - allowed object is String

getType

public java.lang.Integer getType()
Gets the value of the type property.

Returns:
possible object is Integer

setType

public void setType(java.lang.Integer value)
Sets the value of the type property.

Parameters:
value - allowed object is Integer

getVersion

public java.lang.String getVersion()
Gets the value of the version property.

Returns:
possible object is String

setVersion

public void setVersion(java.lang.String value)
Sets the value of the version property.

Parameters:
value - allowed object is String

BlackBerry Administration API
v5.0.3.29

Copyright 2009 Research In Motion Limited. All Rights Reserved.