Package de.hybris.platform.b2ctelcotmfresources.v4.dto

Class Service

java.lang.Object
de.hybris.platform.b2ctelcotmfresources.v4.dto.Service
public class Service extends Object
Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService.

  • Constructor Details

    • Service

      public Service()

  • Method Details

    • id

      public Service id(String id)

    • getId

      public String getId()
      Unique identifier of the service
      Returns:
      id

    • setId

      public void setId(String id)

    • href

      public Service href(String href)

    • getHref

      public String getHref()
      Reference of the service
      Returns:
      href

    • setHref

      public void setHref(String href)

    • category

      public Service category(String category)

    • getCategory

      public String getCategory()
      Is it a customer facing or resource facing service
      Returns:
      category

    • setCategory

      public void setCategory(String category)

    • description

      public Service description(String description)

    • getDescription

      public String getDescription()
      Free-text description of the service
      Returns:
      description

    • setDescription

      public void setDescription(String description)

    • endDate

      public Service endDate(Date endDate)

    • getEndDate

      @Valid public @Valid Date getEndDate()
      Date when the service ends
      Returns:
      endDate

    • setEndDate

      public void setEndDate(Date endDate)

    • hasStarted

      public Service hasStarted(Boolean hasStarted)

    • isHasStarted

      public Boolean isHasStarted()
      If TRUE, this Service has already been started
      Returns:
      hasStarted

    • setHasStarted

      public void setHasStarted(Boolean hasStarted)

    • isBundle

      public Service isBundle(Boolean isBundle)

    • isIsBundle

      public Boolean isIsBundle()
      If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf).
      Returns:
      isBundle

    • setIsBundle

      public void setIsBundle(Boolean isBundle)

    • isServiceEnabled

      public Service isServiceEnabled(Boolean isServiceEnabled)

    • isIsServiceEnabled

      public Boolean isIsServiceEnabled()
      If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed
      Returns:
      isServiceEnabled

    • setIsServiceEnabled

      public void setIsServiceEnabled(Boolean isServiceEnabled)

    • isStateful

      public Service isStateful(Boolean isStateful)

    • isIsStateful

      public Boolean isIsStateful()
      If TRUE, this Service can be changed without affecting any other services
      Returns:
      isStateful

    • setIsStateful

      public void setIsStateful(Boolean isStateful)

    • name

      public Service name(String name)

    • getName

      public String getName()
      Name of the service
      Returns:
      name

    • setName

      public void setName(String name)

    • serviceDate

      public Service serviceDate(String serviceDate)

    • getServiceDate

      public String getServiceDate()
      Date when the service was created (whatever its status).
      Returns:
      serviceDate

    • setServiceDate

      public void setServiceDate(String serviceDate)

    • serviceType

      public Service serviceType(String serviceType)

    • getServiceType

      public String getServiceType()
      Business type of the service
      Returns:
      serviceType

    • setServiceType

      public void setServiceType(String serviceType)

    • startDate

      public Service startDate(Date startDate)

    • getStartDate

      @Valid public @Valid Date getStartDate()
      Date when the service starts
      Returns:
      startDate

    • setStartDate

      public void setStartDate(Date startDate)

    • startMode

      public Service startMode(String startMode)

    • getStartMode

      public String getStartMode()
      This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above
      Returns:
      startMode

    • setStartMode

      public void setStartMode(String startMode)

    • feature

      public Service feature(List<Feature> feature)

    • addFeatureItem

      public Service addFeatureItem(Feature featureItem)

    • getFeature

      @Valid public @Valid List<Feature> getFeature()
      A list of feature associated with this service
      Returns:
      feature

    • setFeature

      public void setFeature(List<Feature> feature)

    • note

      public Service note(List<Note> note)

    • addNoteItem

      public Service addNoteItem(Note noteItem)

    • getNote

      @Valid public @Valid List<Note> getNote()
      A list of notes made on this service
      Returns:
      note

    • setNote

      public void setNote(List<Note> note)

    • place

      public Service place(List<RelatedPlaceRefOrValue> place)

    • addPlaceItem

      public Service addPlaceItem(RelatedPlaceRefOrValue placeItem)

    • getPlace

      @Valid public @Valid List<RelatedPlaceRefOrValue> getPlace()
      A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)
      Returns:
      place

    • setPlace

      public void setPlace(List<RelatedPlaceRefOrValue> place)

    • relatedEntity

      public Service relatedEntity(List<RelatedEntityRefOrValue> relatedEntity)

    • addRelatedEntityItem

      public Service addRelatedEntityItem(RelatedEntityRefOrValue relatedEntityItem)

    • getRelatedEntity

      @Valid public @Valid List<RelatedEntityRefOrValue> getRelatedEntity()
      A list of related entity in relationship with this service
      Returns:
      relatedEntity

    • setRelatedEntity

      public void setRelatedEntity(List<RelatedEntityRefOrValue> relatedEntity)

    • relatedParty

      public Service relatedParty(List<RelatedParty> relatedParty)

    • addRelatedPartyItem

      public Service addRelatedPartyItem(RelatedParty relatedPartyItem)

    • getRelatedParty

      @Valid public @Valid List<RelatedParty> getRelatedParty()
      A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity
      Returns:
      relatedParty

    • setRelatedParty

      public void setRelatedParty(List<RelatedParty> relatedParty)

    • serviceCharacteristic

      public Service serviceCharacteristic(List<Characteristic> serviceCharacteristic)

    • addServiceCharacteristicItem

      public Service addServiceCharacteristicItem(Characteristic serviceCharacteristicItem)

    • getServiceCharacteristic

      @Valid public @Valid List<Characteristic> getServiceCharacteristic()
      A list of characteristics that characterize this service (ServiceCharacteristic [*])
      Returns:
      serviceCharacteristic

    • setServiceCharacteristic

      public void setServiceCharacteristic(List<Characteristic> serviceCharacteristic)

    • serviceOrderItem

      public Service serviceOrderItem(List<RelatedServiceOrderItem> serviceOrderItem)

    • addServiceOrderItemItem

      public Service addServiceOrderItemItem(RelatedServiceOrderItem serviceOrderItemItem)

    • getServiceOrderItem

      @Valid public @Valid List<RelatedServiceOrderItem> getServiceOrderItem()
      A list of service order items related to this service
      Returns:
      serviceOrderItem

    • setServiceOrderItem

      public void setServiceOrderItem(List<RelatedServiceOrderItem> serviceOrderItem)

    • serviceRelationship

      public Service serviceRelationship(List<ServiceRelationship> serviceRelationship)

    • addServiceRelationshipItem

      public Service addServiceRelationshipItem(ServiceRelationship serviceRelationshipItem)

    • getServiceRelationship

      @Valid public @Valid List<ServiceRelationship> getServiceRelationship()
      A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory.
      Returns:
      serviceRelationship

    • setServiceRelationship

      public void setServiceRelationship(List<ServiceRelationship> serviceRelationship)

    • serviceSpecification

      public Service serviceSpecification(ServiceSpecificationRef serviceSpecification)

    • getServiceSpecification

      @Valid public @Valid ServiceSpecificationRef getServiceSpecification()
      Get serviceSpecification
      Returns:
      serviceSpecification

    • setServiceSpecification

      public void setServiceSpecification(ServiceSpecificationRef serviceSpecification)

    • state

      public Service state(ServiceStateType state)

    • getState

      @Valid public @Valid ServiceStateType getState()
      Get state
      Returns:
      state

    • setState

      public void setState(ServiceStateType state)

    • supportingResource

      public Service supportingResource(List<ResourceRef> supportingResource)

    • addSupportingResourceItem

      public Service addSupportingResourceItem(ResourceRef supportingResourceItem)

    • getSupportingResource

      @Valid public @Valid List<ResourceRef> getSupportingResource()
      A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources
      Returns:
      supportingResource

    • setSupportingResource

      public void setSupportingResource(List<ResourceRef> supportingResource)

    • supportingService

      public Service supportingService(List<ServiceRefOrValue> supportingService)

    • addSupportingServiceItem

      public Service addSupportingServiceItem(ServiceRefOrValue supportingServiceItem)

    • getSupportingService

      @Valid public @Valid List<ServiceRefOrValue> getSupportingService()
      A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)
      Returns:
      supportingService

    • setSupportingService

      public void setSupportingService(List<ServiceRefOrValue> supportingService)

    • atBaseType

      public Service atBaseType(String atBaseType)

    • getAtBaseType

      public String getAtBaseType()
      When sub-classing, this defines the super-class
      Returns:
      atBaseType

    • setAtBaseType

      public void setAtBaseType(String atBaseType)

    • atSchemaLocation

      public Service atSchemaLocation(String atSchemaLocation)

    • getAtSchemaLocation

      public String getAtSchemaLocation()
      A URI to a JSON-Schema file that defines additional attributes and relationships
      Returns:
      atSchemaLocation

    • setAtSchemaLocation

      public void setAtSchemaLocation(String atSchemaLocation)

    • atType

      public Service atType(String atType)

    • getAtType

      public String getAtType()
      When sub-classing, this defines the sub-class entity name
      Returns:
      atType

    • setAtType

      public void setAtType(String atType)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object