Workspace (ACS AEM Commons Bundle 4.8.0 API)

java.lang.Object
- com.adobe.acs.commons.workflow.bulk.execution.model.Workspace

@Model(adaptables=org.apache.sling.api.resource.Resource.class)
public class Workspace
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`NN_FAILURE`
`static String`	`NN_FAILURES`
`static String`	`NN_PAYLOADS`
`static String`	`NN_PAYLOADS_LAUNCHPAD`
`static String`	`NN_WORKSPACE`
`static String`	`NT_UNORDERED`
`static String`	`PN_ACTIVE_PAYLOAD_GROUPS`
`static String`	`PN_ACTIVE_PAYLOADS`
`static String`	`PN_STATUS`
`static String`	`PN_SUB_STATUS`

Constructor Summary

Constructors
Constructor and Description

Workspace(org.apache.sling.api.resource.Resource resource)

Constructors
Constructor and Description
`Workspace(org.apache.sling.api.resource.Resource resource)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`activate()`
`void`	`addActivePayload(Payload payload)` Internal logic proxies
`void`	`addActivePayloadGroup(PayloadGroup payloadGroup)` Adds the payload group to the list of active payload groups.
`void`	`addActivePayloads(List<Payload> payloads)`
`void`	`addFailure(Payload payload)`
`void`	`addFailure(String payloadPath, String trackPath, Calendar failedAt)`
`void`	`commit()` Commit the changes for this bulk workflow manager execution.
`String`	`getActionManagerName()`
`List<PayloadGroup>`	`getActivePayloadGroups()`
`List<Payload>`	`getActivePayloads()`
`int`	`getCompleteCount()`
`Calendar`	`getCompletedAt()` Getters
`Config`	`getConfig()`
`int`	`getFailCount()`
`List<Failure>`	`getFailures()`
`String`	`getJobName()`
`String`	`getMessage()`
`String`	`getPath()`
`org.apache.sling.api.resource.ResourceResolver`	`getResourceResolver()`
`BulkWorkflowRunner`	`getRunner()`
`Calendar`	`getStartedAt()`
`Status`	`getStatus()`
`Calendar`	`getStoppedAt()`
`SubStatus`	`getSubStatus()`
`int`	`getTotalCount()`
`int`	`incrementCompleteCount()`
`int`	`incrementFailCount()`
`boolean`	`isActive(PayloadGroup payloadGroup)`
`boolean`	`isInitialized()`
`boolean`	`isRunning()`
`boolean`	`isStopped()`
`boolean`	`isStopping()`
`void`	`removeActivePayload(Payload payload)`
`void`	`removeActivePayloadGroup(PayloadGroup payloadGroup)` Removes the payload group from the list of active payload groups.
`void`	`setActionManagerName(String name)`
`int`	`setCompleteCount(int count)`
`void`	`setCompletedAt(Calendar completedAt)`
`void`	`setError(String message)`
`int`	`setFailureCount(int count)`
`void`	`setInitialized(boolean initialized)`
`void`	`setMessage(String message)`
`void`	`setStartedAt(Calendar startedAt)`
`void`	`setStatus(Status status)` Setters
`void`	`setStatus(Status status, SubStatus subStatus)`
`void`	`setStoppedAt(Calendar stoppedAt)`
`void`	`setTotalCount(int totalCount)`

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

Field Detail
- NT_UNORDERED
```
public static final String NT_UNORDERED
```
  See Also:
  
  Constant Field Values
- NN_FAILURES
```
public static final String NN_FAILURES
```
  See Also:
  
  Constant Field Values
- NN_FAILURE
```
public static final String NN_FAILURE
```
  See Also:
  
  Constant Field Values
- NN_WORKSPACE
```
public static final String NN_WORKSPACE
```
  See Also:
  
  Constant Field Values
- NN_PAYLOADS
```
public static final String NN_PAYLOADS
```
  See Also:
  
  Constant Field Values
- PN_ACTIVE_PAYLOAD_GROUPS
```
public static final String PN_ACTIVE_PAYLOAD_GROUPS
```
  See Also:
  
  Constant Field Values
- PN_ACTIVE_PAYLOADS
```
public static final String PN_ACTIVE_PAYLOADS
```
  See Also:
  
  Constant Field Values
- PN_STATUS
```
public static final String PN_STATUS
```
  See Also:
  
  Constant Field Values
- PN_SUB_STATUS
```
public static final String PN_SUB_STATUS
```
  See Also:
  
  Constant Field Values
- NN_PAYLOADS_LAUNCHPAD
```
public static final String NN_PAYLOADS_LAUNCHPAD
```
  See Also:
  
  Constant Field Values

Constructor Detail

Workspace

public Workspace(org.apache.sling.api.resource.Resource resource)

Method Detail

activate

@PostConstruct
protected void activate()

getCompletedAt
```
public Calendar getCompletedAt()
```
Getters

setCompletedAt

public void setCompletedAt(Calendar completedAt)

getCompleteCount
```
public int getCompleteCount()
```

getFailCount
```
public int getFailCount()
```

getJobName
```
public String getJobName()
```

getTotalCount
```
public int getTotalCount()
```

setTotalCount

public void setTotalCount(int totalCount)

getRunner
```
public BulkWorkflowRunner getRunner()
```

getStartedAt
```
public Calendar getStartedAt()
```

setStartedAt

public void setStartedAt(Calendar startedAt)

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

getStoppedAt
```
public Calendar getStoppedAt()
```

isInitialized
```
public boolean isInitialized()
```

isRunning
```
public boolean isRunning()
```

isStopped
```
public boolean isStopped()
```

isStopping
```
public boolean isStopping()
```

getConfig
```
public Config getConfig()
```

getResourceResolver

public org.apache.sling.api.resource.ResourceResolver getResourceResolver()

isActive

public boolean isActive(PayloadGroup payloadGroup)

getPath
```
public String getPath()
```

getMessage
```
public String getMessage()
```

getActionManagerName
```
public String getActionManagerName()
```

getFailures
```
public List<Failure> getFailures()
```

setStatus
```
public void setStatus(Status status)
```
Setters

setStatus

public void setStatus(Status status,
                      SubStatus subStatus)

getSubStatus
```
public SubStatus getSubStatus()
```

setStoppedAt

public void setStoppedAt(Calendar stoppedAt)

setInitialized

public void setInitialized(boolean initialized)

incrementCompleteCount
```
public int incrementCompleteCount()
```

setCompleteCount

public int setCompleteCount(int count)

incrementFailCount
```
public int incrementFailCount()
```

setFailureCount

public int setFailureCount(int count)

setError
```
public void setError(String message)
```

setMessage

public void setMessage(String message)

setActionManagerName

public void setActionManagerName(String name)

addActivePayload

public void addActivePayload(Payload payload)

Internal logic proxies

addActivePayloads

public void addActivePayloads(List<Payload> payloads)

removeActivePayload

public void removeActivePayload(Payload payload)

getActivePayloads
```
public List<Payload> getActivePayloads()
```
Returns:

a list of the payloads that are being actively processed by bulk workflow manager.

getActivePayloadGroups
```
public List<PayloadGroup> getActivePayloadGroups()
```
Returns:

a list of the payload groups that have atleast 1 payload being process by bulk workflow manager.

addActivePayloadGroup
```
public void addActivePayloadGroup(PayloadGroup payloadGroup)
```
Adds the payload group to the list of active payload groups.

Parameters:

payloadGroup - the payload group to add as active

removeActivePayloadGroup
```
public void removeActivePayloadGroup(PayloadGroup payloadGroup)
```
Removes the payload group from the list of active payload groups.

Parameters:

payloadGroup - the payload group to remove from the active list.

addFailure

public void addFailure(Payload payload)
                throws javax.jcr.RepositoryException

Throws:: javax.jcr.RepositoryException

addFailure

public void addFailure(String payloadPath,
                       String trackPath,
                       Calendar failedAt)
                throws javax.jcr.RepositoryException

Throws:: javax.jcr.RepositoryException

commit
```
public void commit()
            throws org.apache.sling.api.resource.PersistenceException
```
Commit the changes for this bulk workflow manager execution.

Throws:

org.apache.sling.api.resource.PersistenceException

Class Workspace

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NT_UNORDERED

NN_FAILURES

NN_FAILURE

NN_WORKSPACE

NN_PAYLOADS

PN_ACTIVE_PAYLOAD_GROUPS

PN_ACTIVE_PAYLOADS

PN_STATUS

PN_SUB_STATUS

NN_PAYLOADS_LAUNCHPAD

Constructor Detail

Workspace

Method Detail

activate

getCompletedAt

setCompletedAt

getCompleteCount

getFailCount

getJobName

getTotalCount

setTotalCount

getRunner

getStartedAt

setStartedAt

getStatus

getStoppedAt

isInitialized

isRunning

isStopped

isStopping

getConfig

getResourceResolver

isActive

getPath

getMessage

getActionManagerName

getFailures

setStatus

setStatus

getSubStatus

setStoppedAt

setInitialized

incrementCompleteCount

setCompleteCount

incrementFailCount

setFailureCount

setError

setMessage

setActionManagerName

addActivePayload

addActivePayloads

removeActivePayload

getActivePayloads

getActivePayloadGroups

addActivePayloadGroup

removeActivePayloadGroup

addFailure

addFailure

commit