org.apache.lens.server.api.query.save

Interface SavedQueryService

All Known Implementing Classes:

SavedQueryServiceImpl

public interface SavedQueryService

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME The Constant NAME.

Method Summary

Modifier and Type	Method and Description
void	delete(LensSessionHandle handle, long id) Deletes the saved query specified.
SavedQuery	get(LensSessionHandle handle, long id) Returns the saved query pointed out by the id.
void	grant(LensSessionHandle handle, long id, String sharingUser, String targetUserPath, String[] privileges) Grant permissions for users to do actions on the saved query.
ListResponse	list(LensSessionHandle handle, javax.ws.rs.core.MultivaluedMap<String,String> criteria, long start, long count) List the saved query from {start} to {count} matching filter denoted by criteria.
void	revoke(LensSessionHandle handle, long id, String sharingUser, String targetUserPath, String[] privileges) Revoke permissions from users to do actions on the saved query.
long	save(LensSessionHandle handle, SavedQuery query) Saves a query
void	update(LensSessionHandle handle, long id, SavedQuery query) Updates the specified saved query with the new object.

Field Detail

NAME

static final String NAME

The Constant NAME.

See Also:

Constant Field Values

Method Detail

save

long save(LensSessionHandle handle,
          SavedQuery query)
   throws LensException

Saves a query

Parameters:

query - Saved query object.

Returns:

id of the created saved query.

Throws:

LensException

update

void update(LensSessionHandle handle,
            long id,
            SavedQuery query)
     throws LensException

Updates the specified saved query with the new object.

Parameters:

handle - session handle of the query

id - id of the saved query.

query - Saved query object.

Throws:

LensException

delete

void delete(LensSessionHandle handle,
            long id)
     throws LensException

Deletes the saved query specified.

Parameters:

handle - session handle of the query

id - id of the saved query.

Throws:

LensException

get

SavedQuery get(LensSessionHandle handle,
               long id)
        throws LensException

Returns the saved query pointed out by the id.

Parameters:

handle - session handle of the query

id - id of the saved query.

Returns:

saved query object.

Throws:

LensException

list

ListResponse list(LensSessionHandle handle,
                  javax.ws.rs.core.MultivaluedMap<String,String> criteria,
                  long start,
                  long count)
           throws LensException

List the saved query from {start} to {count} matching filter denoted by criteria.

Parameters:

handle - session handle of the query

criteria - Multivalued map representing the criteria.

start - Displacement from the first matching record.

count - Number of records to fetch.

Returns:

list of queries.

Throws:

LensException

grant

void grant(LensSessionHandle handle,
           long id,
           String sharingUser,
           String targetUserPath,
           String[] privileges)
    throws LensException

Grant permissions for users to do actions on the saved query.

Parameters:

handle - session handle of the query

id - id of the query.

sharingUser - User invoking this action.

targetUserPath - Target users who have to get affected.

privileges - Privileges to be granted.

Throws:

LensException

revoke

void revoke(LensSessionHandle handle,
            long id,
            String sharingUser,
            String targetUserPath,
            String[] privileges)
     throws LensException

Revoke permissions from users to do actions on the saved query.

Parameters:

handle - session handle of the query

id - id of the query.

sharingUser - User invoking this action.

targetUserPath - Target users who have to get affected.

privileges - Privileges to be granted.

Throws:

LensException