gCubeSystem
/
ckan-util-library
16
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

removed useless modifier 

git-svn-id: https://svn.d4science.research-infrastructures.eu/gcube/trunk/data-catalogue/ckan-util-library@129563 82a268e6-3cf1-43bd-a215-b396298e98cf
This commit is contained in:
Costantino Perciante 2016-06-28 15:19:45 +00:00
parent 4b967fd9a8
commit 2a3a247351
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
src/main/java/org/gcube/datacatalogue/ckanutillibrary/CKanUtilsInterface.java
View File

@ -20,28 +20,28 @@ public interface CKanUtilsInterface {
* @param username
* @return an API_KEY string on success, null otherwise
*/
public String getApiKeyFromUsername(String username);
String getApiKeyFromUsername(String username);
/**
* Retrieve the user given the API_KEY (the user is retrieved if it is active).
* @param the user api key
* @return an API_KEY string
*/
public CKanUserWrapper getUserFromApiKey(String apiKey);
CKanUserWrapper getUserFromApiKey(String apiKey);
/**
* Returns the list of organizations to whom the user belongs (with any role)
* @param username
* @return a list of organizations
*/
public List<CkanOrganization> getOrganizationsByUser(String username);
List<CkanOrganization> getOrganizationsByUser(String username);
/**
* Returns the list of organizations' names to whom the user belongs (with any role)
* @param username
* @return a list of organizations
*/
public List<String> getOrganizationsNamesByUser(String username);
List<String> getOrganizationsNamesByUser(String username);
/**
* Given a username and a list of roles to be matched, find the organizations in which the user has these roles.
@ -50,38 +50,38 @@ public interface CKanUtilsInterface {
* @param rolesToMatch
* @return a list (orgsName, roles in this organization), null on error
*/
public Map<String, List<RolesIntoOrganization>> getGroupsAndRolesByUser(String username, List<RolesIntoOrganization> rolesToMatch);
Map<String, List<RolesIntoOrganization>> getGroupsAndRolesByUser(String username, List<RolesIntoOrganization> rolesToMatch);
/**
* Return the ckan catalogue url in this scope.
* @return the catalogue url
*/
public String getCatalogueUrl();
String getCatalogueUrl();
/**
* Get the list of licenses' titles.
* @return the list of licenses' titles
*/
public List<String> getLicenseTitles();
List<String> getLicenseTitles();
/**
* Retrieve the list of organizations ids
* @return
*/
public List<String> getOrganizationsIds();
List<String> getOrganizationsIds();
/**
* Retrieve the list of organizations names
* @return
*/
public List<String> getOrganizationsNames();
List<String> getOrganizationsNames();
/**
* Finds the id associated to the chosen license
* @param chosenLicense
* @return the id on success, null otherwise
*/
public String findLicenseIdByLicense(String chosenLicense);
String findLicenseIdByLicense(String chosenLicense);
/**
* Set dataset private
@ -91,7 +91,7 @@ public interface CKanUtilsInterface {
* @param apiKey the user's api key
* @return true on success, false otherwise
*/
public boolean setDatasetPrivate(boolean priv, String organizationId, String datasetId, String apiKey);
boolean setDatasetPrivate(boolean priv, String organizationId, String datasetId, String apiKey);
/**
* Add a resource described by the bean to the dataset id into resource.datasetId
@ -99,7 +99,7 @@ public interface CKanUtilsInterface {
* @param apiKey the user api key
* @return String the id of the resource on success, null otherwise
*/
public String addResourceToDataset(ResourceBean resource, String apiKey);
String addResourceToDataset(ResourceBean resource, String apiKey);
/**
* Remove the resource with id resourceId from the dataset in which it is.
@ -107,7 +107,7 @@ public interface CKanUtilsInterface {
* @param apiKey the user's api key
* @return true on success, false otherwise.
*/
public boolean deleteResourceFromDataset(String resourceId, String apiKey);
boolean deleteResourceFromDataset(String resourceId, String apiKey);
/**
* Create a dataset with those information.
@ -128,7 +128,7 @@ public interface CKanUtilsInterface {
* @param setPublic (manage visibility)
* @return the id of the dataset on success, null otherwise
*/
public String createCKanDataset(String apiKey, String withId, String title, String organizationNameOrId, String author,
String createCKanDataset(String apiKey, String withId, String title, String organizationNameOrId, String author,
String authorMail, String maintainer, String maintainerMail, long version, String description, String licenseId,
List<String> tags, Map<String, String> customFields, List<ResourceBean> resources, boolean setPublic);
@ -138,7 +138,7 @@ public interface CKanUtilsInterface {
* @param datasetId
* @return The url of the dataset on success, null otherwise
*/
public String getUrlFromDatasetIdOrName(String apiKey, String datasetIdOrName);
String getUrlFromDatasetIdOrName(String apiKey, String datasetIdOrName);
/**
* Check if this user is a sysadmin. The api key is used to authorize this call.
@ -146,7 +146,7 @@ public interface CKanUtilsInterface {
* @param apiKey the current user's api key
* @return true on success, false otherwise
*/
public boolean isSysAdmin(String username, String apiKey);
boolean isSysAdmin(String username, String apiKey);
/**
* Check if this role is present for this user in that organization. If it is not present we need to add it.
@ -155,7 +155,7 @@ public interface CKanUtilsInterface {
* @param correspondentRoleToCheck
* @return true if the role can be set, false if it cannot
*/
public boolean checkRole(String username, String organizationName,
boolean checkRole(String username, String organizationName,
RolesIntoOrganization correspondentRoleToCheck);
/**
@ -165,5 +165,5 @@ public interface CKanUtilsInterface {
* @return true on success, false otherwise
* @throws Exception
*/
public boolean createOrganization(String orgName, String token) throws Exception;
boolean createOrganization(String orgName, String token) throws Exception;
}