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

Methods

Modifier and Type	Method and Description
void	delete(long id) Deletes the saved query specified.
SavedQuery	get(long id) Returns the saved query pointed out by the id.
void	grant(long id, String sharingUser, String targetUserPath, String[] privileges) Grant permissions for users to do actions on the saved query.
ListResponse	list(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(long id, String sharingUser, String targetUserPath, String[] privileges) Revoke permissions from users to do actions on the saved query.
long	save(SavedQuery query) Saves a query
void	update(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(SavedQuery query)
          throws LensException

Saves a query

Parameters:

query - Saved query object.

Returns:

id of the created saved query.

Throws:

LensException

update

void update(long id,
          SavedQuery query)
            throws LensException

Updates the specified saved query with the new object.

Parameters:

id - id of the saved query.

query - Saved query object.

Throws:

LensException

delete

void delete(long id)
            throws LensException

Deletes the saved query specified.

Parameters:

id - id of the saved query.

Throws:

LensException

get

SavedQuery get(long id)
               throws LensException

Returns the saved query pointed out by the id.

Parameters:

id - id of the saved query.

Returns:

saved query object.

Throws:

LensException

list

ListResponse list(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:

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(long id,
         String sharingUser,
         String targetUserPath,
         String[] privileges)
           throws LensException

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

Parameters:

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(long id,
          String sharingUser,
          String targetUserPath,
          String[] privileges)
            throws LensException

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

Parameters:

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