UsageSession (billforward-java 1.2014.260 API)

java.lang.Object
- net.billforward.model.BillingEntity
- - net.billforward.model.InsertableEntity<UsageSession>
  - - net.billforward.model.usage.UsageSession

public class UsageSession
extends InsertableEntity<UsageSession>

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`changedBy`
`protected Date`	`created`
`protected String`	`description`
`protected String`	`organizationID`
`protected static ResourcePath`	`resourcePath`
`protected String`	`sessionID`
`protected long`	`sessionix`
`protected Date`	`start`
`protected String`	`state`
`protected Date`	`stop`
`protected String`	`subscriptionID`
`protected String`	`uom`
`protected UsageSession[]`	`usageSessions`

Fields inherited from class net.billforward.model.BillingEntity
m_client, PRETTY_PRINT_GSON

Constructor Summary

Constructors
Modifier Constructor and Description

protected UsageSession()

UsageSession(BillForwardClient client_)

UsageSession(UsageSession[] sessions)

Constructors
Modifier	Constructor and Description
`protected`	`UsageSession()`
	`UsageSession(BillForwardClient client_)`
	`UsageSession(UsageSession[] sessions)`

Method Summary

Methods
Modifier and Type	Method and Description
`static UsageSession[]`	`getActiveSessionsForSubscription(String subscriptionID_)`
`String`	`getChangedBy()`
`Date`	`getCreated()`
`String`	`getDescription()`
`String`	`getOrganizationID()`
`protected ResourcePath`	`getResourcePath()`
`String`	`getSessionID()`
`long`	`getSessionix()`
`static UsageSession[]`	`getSessionsForSubscription(String subscriptionID_)`
`Date`	`getStart()`
`UsageState`	`getState()`
`String`	`getStateAsString()`
`Date`	`getStop()`
`String`	`getSubscriptionID()`
`String`	`getUom()`
`protected static ResourcePath`	`ResourcePath()`
`void`	`setDescription(String description)`
`void`	`setSessionID(String sessionID)`
`void`	`setStart(Date start)`
`void`	`setStop(Date stop)`
`void`	`setSubscriptionID(String subscriptionID)`
`void`	`setUom(String uom)`
`static UsageSession`	`startSession(UnitOfMeasure uom, String subscriptionID)`
`static UsageSession`	`startSession(UnitOfMeasure uom, String subscriptionID, String sessionID)`
`static UsageSession[]`	`startSessions(UsageSession[] sessions_)`
`static UsageSession`	`stopSession(UnitOfMeasure uom, String subscriptionID, String sessionID)`
`static UsageSession[]`	`stopSession(UsageSession[] sessions_)`

Methods inherited from class net.billforward.model.InsertableEntity
create, create, retire

Methods inherited from class net.billforward.model.BillingEntity
getAll, getByID, getByID, getByIDPostPath, getClient, setClient, toString

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

Field Detail

usageSessions
```
protected UsageSession[] usageSessions
```

subscriptionID
```
protected String subscriptionID
```

organizationID
```
protected String organizationID
```

sessionID
```
protected String sessionID
```

uom
```
protected String uom
```

description
```
protected String description
```

sessionix
```
protected long sessionix
```

start
```
protected Date start
```

stop
```
protected Date stop
```

state
```
protected String state
```

changedBy
```
protected String changedBy
```

created
```
protected Date created
```

resourcePath

protected static ResourcePath resourcePath

Constructor Detail

UsageSession

public UsageSession(UsageSession[] sessions)

UsageSession

public UsageSession(BillForwardClient client_)

UsageSession
```
protected UsageSession()
```

Method Detail

getSubscriptionID
```
public String getSubscriptionID()
```

setSubscriptionID

public void setSubscriptionID(String subscriptionID)

getSessionID
```
public String getSessionID()
```

setSessionID

public void setSessionID(String sessionID)

getUom
```
public String getUom()
```

setUom
```
public void setUom(String uom)
```

getDescription
```
public String getDescription()
```

setDescription

public void setDescription(String description)

getStart
```
public Date getStart()
```

setStart
```
public void setStart(Date start)
```

getStop
```
public Date getStop()
```

setStop
```
public void setStop(Date stop)
```

getOrganizationID
```
public String getOrganizationID()
```

getSessionix
```
public long getSessionix()
```

getStateAsString
```
public String getStateAsString()
```

getState
```
public UsageState getState()
```

getChangedBy
```
public String getChangedBy()
```

getCreated
```
public Date getCreated()
```

startSession

public static UsageSession startSession(UnitOfMeasure uom,
                        String subscriptionID)
                                 throws AuthenticationException,
                                        InvalidRequestException,
                                        APIConnectionException,
                                        CardException,
                                        APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

startSession

public static UsageSession startSession(UnitOfMeasure uom,
                        String subscriptionID,
                        String sessionID)
                                 throws AuthenticationException,
                                        InvalidRequestException,
                                        APIConnectionException,
                                        CardException,
                                        APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

startSessions

public static UsageSession[] startSessions(UsageSession[] sessions_)
                                    throws AuthenticationException,
                                           InvalidRequestException,
                                           APIConnectionException,
                                           CardException,
                                           APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

getSessionsForSubscription

public static UsageSession[] getSessionsForSubscription(String subscriptionID_)
                                                 throws AuthenticationException,
                                                        InvalidRequestException,
                                                        APIConnectionException,
                                                        CardException,
                                                        APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

getActiveSessionsForSubscription

public static UsageSession[] getActiveSessionsForSubscription(String subscriptionID_)
                                                       throws AuthenticationException,
                                                              InvalidRequestException,
                                                              APIConnectionException,
                                                              CardException,
                                                              APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

stopSession

public static UsageSession stopSession(UnitOfMeasure uom,
                       String subscriptionID,
                       String sessionID)
                                throws AuthenticationException,
                                       InvalidRequestException,
                                       APIConnectionException,
                                       CardException,
                                       APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

stopSession

public static UsageSession[] stopSession(UsageSession[] sessions_)
                                  throws AuthenticationException,
                                         InvalidRequestException,
                                         APIConnectionException,
                                         CardException,
                                         APIException

Throws:: AuthenticationException; InvalidRequestException; APIConnectionException; CardException; APIException

getResourcePath
```
protected ResourcePath getResourcePath()
```
Specified by:

getResourcePath in class BillingEntity

ResourcePath

protected static ResourcePath ResourcePath()

Class UsageSession

Field Summary

Fields inherited from class net.billforward.model.BillingEntity

Constructor Summary

Method Summary

Methods inherited from class net.billforward.model.InsertableEntity

Methods inherited from class net.billforward.model.BillingEntity

Methods inherited from class java.lang.Object

Field Detail

usageSessions

subscriptionID

organizationID

sessionID

uom

description

sessionix

start

stop

state

changedBy

created

resourcePath

Constructor Detail

UsageSession

UsageSession

UsageSession

Method Detail

getSubscriptionID

setSubscriptionID

getSessionID

setSessionID

getUom

setUom

getDescription

setDescription

getStart

setStart

getStop

setStop

getOrganizationID

getSessionix

getStateAsString

getState

getChangedBy

getCreated

startSession

startSession

startSessions

getSessionsForSubscription

getActiveSessionsForSubscription

stopSession

stopSession

getResourcePath

ResourcePath