ActivityServiceInterface (DFP Axis classes 1.25.0 API)

All Superinterfaces:

Remote

All Known Implementing Classes:

ActivityServiceSoapBindingStub
```
public interface ActivityServiceInterface
extends Remote
```

Method Summary

Methods
Modifier and Type	Method and Description
`Activity[]`	`createActivities(Activity[] activities)` Creates a new `Activity` objects.
`Activity`	`createActivity(Activity activity)` Creates a new `Activity`.
`ActivityPage`	`getActivitiesByStatement(Statement filterStatement)` Gets an `ActivityPage` of `Activity` objects that satisfy the given `Statement.query`.
`Activity`	`getActivity(Integer activityId)` Returns the `Activity` uniquely identified by the given ID.
`Activity[]`	`updateActivities(Activity[] activities)` Updates the specified `Activity` objects.
`Activity`	`updateActivity(Activity activity)` Updates the specified `Activity`.

Method Detail

createActivities

Activity[] createActivities(Activity[] activities)
                            throws RemoteException,
                                   ApiException

Creates a new Activity objects.

Parameters:: activities - to be created.
Returns:: the created activities with its IDs filled in.
Throws:: RemoteException; ApiException

createActivity

Activity createActivity(Activity activity)
                        throws RemoteException,
                               ApiException

Creates a new Activity.

Parameters:: activity - to be created
Returns:: the created activity with its ID filled in.
Throws:: RemoteException; ApiException

getActivitiesByStatement

ActivityPage getActivitiesByStatement(Statement filterStatement)
                                      throws RemoteException,
                                             ApiException

Gets an ActivityPage of Activity objects that satisfy the given Statement.query. The following fields are supported for filtering:

PQL Property	Object Property
`id`	`Activity.id`
`name`	`Activity.name`
`expectedURL`	`Activity.expectedURL`
`status`	`Activity.status`
`activityGroupId`	`Activity.activityGroupId`

Parameters:: filterStatement - a statement used to filter a set of activities.
Returns:: the activities that match the given filter.
Throws:: RemoteException; ApiException

getActivity
```
Activity getActivity(Integer activityId)
                     throws RemoteException,
                            ApiException
```
Returns the Activity uniquely identified by the given ID.

Parameters:
activityId - the ID of the activity, which must already exist

Returns:
the Activity uniquely identified by the given ID

Throws:

RemoteException

ApiException

updateActivities

Activity[] updateActivities(Activity[] activities)
                            throws RemoteException,
                                   ApiException

Updates the specified Activity objects.

Parameters:: activities - to be updated.
Returns:: the updated activities.
Throws:: RemoteException; ApiException

updateActivity

Activity updateActivity(Activity activity)
                        throws RemoteException,
                               ApiException

Updates the specified Activity.

Parameters:: activity - to be updated.
Returns:: the updated activity.
Throws:: RemoteException; ApiException

Interface ActivityServiceInterface