UserServiceInterface (Ad Manager Axis classes 4.20.0 API)

All Superinterfaces:

Remote

All Known Implementing Classes:

UserServiceSoapBindingStub
```
public interface UserServiceInterface
extends Remote
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`User[]`	`createUsers(User[] users)` Creates new `User` objects.
`Role[]`	`getAllRoles()` Returns the `Role` objects that are defined for the users of the network.
`User`	`getCurrentUser()` Returns the current `User`.
`UserPage`	`getUsersByStatement(Statement filterStatement)` Gets a `UserPage` of `User` objects that satisfy the given `Statement.query`.
`UpdateResult`	`performUserAction(UserAction userAction, Statement filterStatement)` Performs actions on `User` objects that match the given `Statement.query`.
`User[]`	`updateUsers(User[] users)` Updates the specified `User` objects.

Method Detail

createUsers

User[] createUsers(User[] users)
            throws RemoteException,
                   ApiException

Creates new User objects.

Throws:: RemoteException; ApiException

getAllRoles
```
Role[] getAllRoles()
            throws RemoteException,
                   ApiException
```
Returns the Role objects that are defined for the users of the network.

Throws:

RemoteException

ApiException

getCurrentUser

User getCurrentUser()
             throws RemoteException,
                    ApiException

Returns the current User.

Throws:: RemoteException; ApiException

getUsersByStatement

UserPage getUsersByStatement(Statement filterStatement)
                      throws RemoteException,
                             ApiException

Gets a UserPage of User objects that satisfy the given Statement.query. The following fields are supported for filtering:

PQL Property	Object Property
`email`	`UserRecord.email`
`id`	`UserRecord.id`
`name`	`UserRecord.name`
`roleId`	`UserRecord.roleId`
`rolename`	`UserRecord.roleName`
`status`	`ACTIVE` if `User.isActive` is true; `INACTIVE` otherwise

Throws:: RemoteException; ApiException

performUserAction

UpdateResult performUserAction(UserAction userAction,
                               Statement filterStatement)
                        throws RemoteException,
                               ApiException

Performs actions on User objects that match the given Statement.query.

Throws:: RemoteException; ApiException

updateUsers

User[] updateUsers(User[] users)
            throws RemoteException,
                   ApiException

Updates the specified User objects.

Throws:: RemoteException; ApiException

Interface UserServiceInterface