com.google.api.ads.dfp.axis.v201201
Class UserServiceSoapBindingStub

java.lang.Object
  org.apache.axis.client.Stub
      com.google.api.ads.dfp.axis.v201201.UserServiceSoapBindingStub

All Implemented Interfaces:

UserServiceInterface, Remote, javax.xml.rpc.Stub

public class UserServiceSoapBindingStub
extends org.apache.axis.client.Stub
implements UserServiceInterface

Field Summary

Fields inherited from class org.apache.axis.client.Stub

_call, cachedEndpoint, cachedPassword, cachedPortName, cachedProperties, cachedTimeout, cachedUsername, maintainSession, maintainSessionSet, service

Fields inherited from interface javax.xml.rpc.Stub

ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, USERNAME_PROPERTY

Constructor Summary

UserServiceSoapBindingStub()

UserServiceSoapBindingStub(javax.xml.rpc.Service service)

UserServiceSoapBindingStub(URL endpointURL, javax.xml.rpc.Service service)

Method Summary

protected org.apache.axis.client.Call	createCall()
User	createUser(User user) Creates a new User.
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.
User	getUser(Long userId) Returns the User uniquely identified by the given ID.
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	updateUser(User user) Updates the specified User.
User[]	updateUsers(User[] users) Updates the specified User objects.

Methods inherited from class org.apache.axis.client.Stub

_createCall, _getCall, _getProperty, _getPropertyNames, _getService, _setProperty, addAttachment, clearAttachments, clearHeaders, extractAttachments, firstCall, getAttachments, getHeader, getHeaders, getPassword, getPortName, getResponseHeader, getResponseHeaders, getResponseHeaders, getTimeout, getUsername, removeProperty, setAttachments, setHeader, setHeader, setMaintainSession, setPassword, setPortName, setPortName, setRequestHeaders, setTimeout, setUsername

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserServiceSoapBindingStub

public UserServiceSoapBindingStub()
                           throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

UserServiceSoapBindingStub

public UserServiceSoapBindingStub(URL endpointURL,
                                  javax.xml.rpc.Service service)
                           throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

UserServiceSoapBindingStub

public UserServiceSoapBindingStub(javax.xml.rpc.Service service)
                           throws org.apache.axis.AxisFault

Throws:

org.apache.axis.AxisFault

Method Detail

createCall

protected org.apache.axis.client.Call createCall()
                                          throws RemoteException

Throws:

RemoteException

createUser

public User createUser(User user)
                throws RemoteException,
                       ApiException

Description copied from interface: UserServiceInterface

Creates a new User. The following fields are required:

• UserRecord.email
• UserRecord.name

Specified by:

createUser in interface UserServiceInterface

Parameters:

user - the user to create

Returns:

the new user with its ID filled in

Throws:

RemoteException

ApiException

createUsers

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

Description copied from interface: UserServiceInterface

Creates new User objects.

Specified by:

createUsers in interface UserServiceInterface

Parameters:

users - the users to create

Returns:

the created users with their IDs filled in

Throws:

RemoteException

ApiException

getAllRoles

public Role[] getAllRoles()
                   throws RemoteException,
                          ApiException

Description copied from interface: UserServiceInterface

Returns the Role objects that are defined for the users of the network.

Specified by:

getAllRoles in interface UserServiceInterface

Returns:

the roles defined for the user's network

Throws:

RemoteException

ApiException

getCurrentUser

public User getCurrentUser()
                    throws RemoteException,
                           ApiException

Description copied from interface: UserServiceInterface

Returns the current User.

Specified by:

getCurrentUser in interface UserServiceInterface

Returns:

the current user

Throws:

RemoteException

ApiException

getUser

public User getUser(Long userId)
             throws RemoteException,
                    ApiException

Description copied from interface: UserServiceInterface

Returns the User uniquely identified by the given ID.

Specified by:

getUser in interface UserServiceInterface

Parameters:

userId - The optional ID of the user. For current user set to null.

Returns:

the User uniquely identified by the given ID

Throws:

RemoteException

ApiException

getUsersByStatement

public UserPage getUsersByStatement(Statement filterStatement)
                             throws RemoteException,
                                    ApiException

Description copied from interface: UserServiceInterface

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

Specified by:

getUsersByStatement in interface UserServiceInterface

Parameters:

filterStatement - a Publisher Query Language statement used to filter a set of users

Returns:

the users that match the given filter

Throws:

RemoteException

ApiException

performUserAction

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

Description copied from interface: UserServiceInterface

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

Specified by:

performUserAction in interface UserServiceInterface

Parameters:

userAction - the action to perform

filterStatement - a Publisher Query Language statement used to filter a set of users

Returns:

the result of the action performed

Throws:

RemoteException

ApiException

updateUser

public User updateUser(User user)
                throws RemoteException,
                       ApiException

Description copied from interface: UserServiceInterface

Updates the specified User.

Specified by:

updateUser in interface UserServiceInterface

Parameters:

user - the user to update

Returns:

the updated user

Throws:

RemoteException

ApiException

updateUsers

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

Description copied from interface: UserServiceInterface

Updates the specified User objects.

Specified by:

updateUsers in interface UserServiceInterface

Parameters:

users - the users to update

Returns:

the updated users

Throws:

RemoteException

ApiException