java.lang.Object
- com.softlayer.api.Type
- - com.softlayer.api.service.Entity
  - - com.softlayer.api.service.account.Agreement

@ApiType("SoftLayer_Account_Agreement")
public class Agreement
extends Entity

See Also:: SoftLayer_Account_Agreement

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Agreement.Mask

static interface Agreement.Service

static interface Agreement.ServiceAsync

Field Summary

Fields
Modifier and Type	Field	Description
`protected Account`	`account`
`protected Type`	`agreementType`	The type of agreement.
`protected Long`	`agreementTypeId`	The type of agreement identifier.
`protected boolean`	`agreementTypeIdSpecified`
`protected Long`	`attachedBillingAgreementFileCount`	A count of the files attached to an agreement.
`protected List<MasterServiceAgreement>`	`attachedBillingAgreementFiles`	The files attached to an agreement.
`protected Long`	`autoRenew`
`protected boolean`	`autoRenewSpecified`
`protected Long`	`billingItemCount`	A count of the billing items associated with an agreement.
`protected List<Item>`	`billingItems`	The billing items associated with an agreement.
`protected Long`	`cancellationFee`
`protected boolean`	`cancellationFeeSpecified`
`protected GregorianCalendar`	`createDate`	The date an agreement was created.
`protected boolean`	`createDateSpecified`
`protected Long`	`durationMonths`	The duration in months of an agreement.
`protected boolean`	`durationMonthsSpecified`
`protected GregorianCalendar`	`endDate`	The end date of an agreement.
`protected boolean`	`endDateSpecified`
`protected Long`	`id`	An agreement's internal identifier.
`protected boolean`	`idSpecified`
`protected GregorianCalendar`	`startDate`	The effective start date of an agreement.
`protected boolean`	`startDateSpecified`
`protected Status`	`status`	The status of the agreement.
`protected Long`	`statusId`	The status identifier for an agreement.
`protected boolean`	`statusIdSpecified`
`protected String`	`title`	The title of an agreement.
`protected boolean`	`titleSpecified`
`protected Long`	`topLevelBillingItemCount`	A count of the top level billing item associated with an agreement.
`protected List<Item>`	`topLevelBillingItems`	The top level billing item associated with an agreement.

Fields inherited from class com.softlayer.api.Type
unknownProperties

Constructor Summary

Constructors
Constructor Description

Agreement()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Agreement.Service`	`asService(ApiClient client)`
`Account`	`getAccount()`
`Type`	`getAgreementType()`
`Long`	`getAgreementTypeId()`
`Long`	`getAttachedBillingAgreementFileCount()`
`List<MasterServiceAgreement>`	`getAttachedBillingAgreementFiles()`
`Long`	`getAutoRenew()`
`Long`	`getBillingItemCount()`
`List<Item>`	`getBillingItems()`
`Long`	`getCancellationFee()`
`GregorianCalendar`	`getCreateDate()`
`Long`	`getDurationMonths()`
`GregorianCalendar`	`getEndDate()`
`Long`	`getId()`
`GregorianCalendar`	`getStartDate()`
`Status`	`getStatus()`
`Long`	`getStatusId()`
`String`	`getTitle()`
`Long`	`getTopLevelBillingItemCount()`
`List<Item>`	`getTopLevelBillingItems()`
`boolean`	`isAgreementTypeIdSpecified()`
`boolean`	`isAutoRenewSpecified()`
`boolean`	`isCancellationFeeSpecified()`
`boolean`	`isCreateDateSpecified()`
`boolean`	`isDurationMonthsSpecified()`
`boolean`	`isEndDateSpecified()`
`boolean`	`isIdSpecified()`
`boolean`	`isStartDateSpecified()`
`boolean`	`isStatusIdSpecified()`
`boolean`	`isTitleSpecified()`
`static Agreement.Service`	`service(ApiClient client)`
`static Agreement.Service`	`service(ApiClient client, Long id)`
`void`	`setAccount(Account account)`
`void`	`setAgreementType(Type agreementType)`
`void`	`setAgreementTypeId(Long agreementTypeId)`
`void`	`setAttachedBillingAgreementFileCount(Long attachedBillingAgreementFileCount)`
`void`	`setAutoRenew(Long autoRenew)`
`void`	`setBillingItemCount(Long billingItemCount)`
`void`	`setCancellationFee(Long cancellationFee)`
`void`	`setCreateDate(GregorianCalendar createDate)`
`void`	`setDurationMonths(Long durationMonths)`
`void`	`setEndDate(GregorianCalendar endDate)`
`void`	`setId(Long id)`
`void`	`setStartDate(GregorianCalendar startDate)`
`void`	`setStatus(Status status)`
`void`	`setStatusId(Long statusId)`
`void`	`setTitle(String title)`
`void`	`setTopLevelBillingItemCount(Long topLevelBillingItemCount)`
`void`	`unsetAgreementTypeId()`
`void`	`unsetAutoRenew()`
`void`	`unsetCancellationFee()`
`void`	`unsetCreateDate()`
`void`	`unsetDurationMonths()`
`void`	`unsetEndDate()`
`void`	`unsetId()`
`void`	`unsetStartDate()`
`void`	`unsetStatusId()`
`void`	`unsetTitle()`

Methods inherited from class com.softlayer.api.Type
getUnknownProperties, setUnknownProperties

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

account
```
@ApiProperty
protected Account account
```

agreementType

@ApiProperty
protected Type agreementType

The type of agreement.

attachedBillingAgreementFiles

@ApiProperty
protected List<MasterServiceAgreement> attachedBillingAgreementFiles

The files attached to an agreement.

billingItems
```
@ApiProperty
protected List<Item> billingItems
```
The billing items associated with an agreement.

status
```
@ApiProperty
protected Status status
```
The status of the agreement.

topLevelBillingItems
```
@ApiProperty
protected List<Item> topLevelBillingItems
```
The top level billing item associated with an agreement.

agreementTypeId

@ApiProperty(canBeNullOrNotSet=true)
protected Long agreementTypeId

The type of agreement identifier.

agreementTypeIdSpecified

protected boolean agreementTypeIdSpecified

autoRenew

@ApiProperty(canBeNullOrNotSet=true)
protected Long autoRenew

autoRenewSpecified
```
protected boolean autoRenewSpecified
```

cancellationFee

@ApiProperty(canBeNullOrNotSet=true)
protected Long cancellationFee

cancellationFeeSpecified

protected boolean cancellationFeeSpecified

createDate

@ApiProperty(canBeNullOrNotSet=true)
protected GregorianCalendar createDate

The date an agreement was created.

createDateSpecified
```
protected boolean createDateSpecified
```

durationMonths

@ApiProperty(canBeNullOrNotSet=true)
protected Long durationMonths

The duration in months of an agreement.

durationMonthsSpecified

protected boolean durationMonthsSpecified

endDate

@ApiProperty(canBeNullOrNotSet=true)
protected GregorianCalendar endDate

The end date of an agreement.

endDateSpecified
```
protected boolean endDateSpecified
```

id

@ApiProperty(canBeNullOrNotSet=true)
protected Long id

An agreement's internal identifier.

idSpecified
```
protected boolean idSpecified
```

startDate

@ApiProperty(canBeNullOrNotSet=true)
protected GregorianCalendar startDate

The effective start date of an agreement.

startDateSpecified
```
protected boolean startDateSpecified
```

statusId

@ApiProperty(canBeNullOrNotSet=true)
protected Long statusId

The status identifier for an agreement.

statusIdSpecified
```
protected boolean statusIdSpecified
```

title

@ApiProperty(canBeNullOrNotSet=true)
protected String title

The title of an agreement.

titleSpecified
```
protected boolean titleSpecified
```

attachedBillingAgreementFileCount
```
@ApiProperty
protected Long attachedBillingAgreementFileCount
```
A count of the files attached to an agreement.

billingItemCount
```
@ApiProperty
protected Long billingItemCount
```
A count of the billing items associated with an agreement.

topLevelBillingItemCount
```
@ApiProperty
protected Long topLevelBillingItemCount
```
A count of the top level billing item associated with an agreement.

Constructor Detail
- Agreement
```
public Agreement()
```

Method Detail

getAccount
```
public Account getAccount()
```

setAccount

public void setAccount(Account account)

getAgreementType
```
public Type getAgreementType()
```

setAgreementType

public void setAgreementType(Type agreementType)

getAttachedBillingAgreementFiles

public List<MasterServiceAgreement> getAttachedBillingAgreementFiles()

getBillingItems
```
public List<Item> getBillingItems()
```

getStatus
```
public Status getStatus()
```

setStatus

public void setStatus(Status status)

getTopLevelBillingItems

public List<Item> getTopLevelBillingItems()

getAgreementTypeId
```
public Long getAgreementTypeId()
```

setAgreementTypeId

public void setAgreementTypeId(Long agreementTypeId)

isAgreementTypeIdSpecified

public boolean isAgreementTypeIdSpecified()

unsetAgreementTypeId
```
public void unsetAgreementTypeId()
```

getAutoRenew
```
public Long getAutoRenew()
```

setAutoRenew

public void setAutoRenew(Long autoRenew)

isAutoRenewSpecified
```
public boolean isAutoRenewSpecified()
```

unsetAutoRenew
```
public void unsetAutoRenew()
```

getCancellationFee
```
public Long getCancellationFee()
```

setCancellationFee

public void setCancellationFee(Long cancellationFee)

isCancellationFeeSpecified

public boolean isCancellationFeeSpecified()

unsetCancellationFee
```
public void unsetCancellationFee()
```

getCreateDate

public GregorianCalendar getCreateDate()

setCreateDate

public void setCreateDate(GregorianCalendar createDate)

isCreateDateSpecified

public boolean isCreateDateSpecified()

unsetCreateDate
```
public void unsetCreateDate()
```

getDurationMonths
```
public Long getDurationMonths()
```

setDurationMonths

public void setDurationMonths(Long durationMonths)

isDurationMonthsSpecified

public boolean isDurationMonthsSpecified()

unsetDurationMonths
```
public void unsetDurationMonths()
```

getEndDate
```
public GregorianCalendar getEndDate()
```

setEndDate

public void setEndDate(GregorianCalendar endDate)

isEndDateSpecified
```
public boolean isEndDateSpecified()
```

unsetEndDate
```
public void unsetEndDate()
```

getId
```
public Long getId()
```

setId
```
public void setId(Long id)
```

isIdSpecified
```
public boolean isIdSpecified()
```

unsetId
```
public void unsetId()
```

getStartDate

public GregorianCalendar getStartDate()

setStartDate

public void setStartDate(GregorianCalendar startDate)

isStartDateSpecified
```
public boolean isStartDateSpecified()
```

unsetStartDate
```
public void unsetStartDate()
```

getStatusId
```
public Long getStatusId()
```

setStatusId

public void setStatusId(Long statusId)

isStatusIdSpecified
```
public boolean isStatusIdSpecified()
```

unsetStatusId
```
public void unsetStatusId()
```

getTitle
```
public String getTitle()
```

setTitle

public void setTitle(String title)

isTitleSpecified
```
public boolean isTitleSpecified()
```

unsetTitle
```
public void unsetTitle()
```

getAttachedBillingAgreementFileCount

public Long getAttachedBillingAgreementFileCount()

setAttachedBillingAgreementFileCount

public void setAttachedBillingAgreementFileCount(Long attachedBillingAgreementFileCount)

getBillingItemCount
```
public Long getBillingItemCount()
```

setBillingItemCount

public void setBillingItemCount(Long billingItemCount)

getTopLevelBillingItemCount

public Long getTopLevelBillingItemCount()

setTopLevelBillingItemCount

public void setTopLevelBillingItemCount(Long topLevelBillingItemCount)

asService

public Agreement.Service asService(ApiClient client)

service

public static Agreement.Service service(ApiClient client)

service

public static Agreement.Service service(ApiClient client,
                                        Long id)

Modifier and Type	Class	Description
`static class`	`Agreement.Mask`
`static interface`	`Agreement.Service`
`static interface`	`Agreement.ServiceAsync`

Class Agreement

Nested Class Summary

Field Summary

Fields inherited from class com.softlayer.api.Type

Constructor Summary

Method Summary

Methods inherited from class com.softlayer.api.Type

Methods inherited from class java.lang.Object

Field Detail

account

agreementType

attachedBillingAgreementFiles

billingItems

status

topLevelBillingItems

agreementTypeId

agreementTypeIdSpecified

autoRenew

autoRenewSpecified

cancellationFee

cancellationFeeSpecified

createDate

createDateSpecified

durationMonths

durationMonthsSpecified

endDate

endDateSpecified

id

idSpecified

startDate

startDateSpecified

statusId

statusIdSpecified

title

titleSpecified

attachedBillingAgreementFileCount

billingItemCount

topLevelBillingItemCount

Constructor Detail

Agreement

Method Detail

getAccount

setAccount

getAgreementType

setAgreementType

getAttachedBillingAgreementFiles

getBillingItems

getStatus

setStatus

getTopLevelBillingItems

getAgreementTypeId

setAgreementTypeId

isAgreementTypeIdSpecified

unsetAgreementTypeId

getAutoRenew

setAutoRenew

isAutoRenewSpecified

unsetAutoRenew

getCancellationFee

setCancellationFee

isCancellationFeeSpecified

unsetCancellationFee

getCreateDate

setCreateDate

isCreateDateSpecified

unsetCreateDate

getDurationMonths

setDurationMonths

isDurationMonthsSpecified

unsetDurationMonths

getEndDate

setEndDate

isEndDateSpecified

unsetEndDate

getId

setId

isIdSpecified

unsetId

getStartDate

setStartDate