Interface WikirateClient

All Known Implementing Classes:
WikirateClientImpl

public interface WikirateClient
Interface for WikiRate Client
Author:
Vasiliki Gkatziaki
  • Method Details

    • getCompany

      Company getCompany(String name)
      Returns a Company based on its name
      Parameters:
      name -
      Returns:
    • getCompany

      Company getCompany(long id)
      Returns a Company based on its identifier
      Parameters:
      id -
      Returns:
    • addCompany

      long addCompany(Company company)
      Adds a new Company on WikiRate and returns its identifier
      Parameters:
      company -
      Returns:
      the identifier on WikiRate of the new Company
    • updateCompany

      void updateCompany(Company company)
      Updates an existing Company on WikiRate
      Parameters:
      company -
    • getSuggestions

      List<Company> getSuggestions(String companyName)
      Returns Company suggestions based on a given company name
      Parameters:
      companyName -
      Returns:
    • getCompanies

      List<Company> getCompanies(CompanyQuery query)
      Returns a List of Companies based on a given query
      Parameters:
      query -
      Returns:
    • getMetric

      Metric getMetric(String metricDesigner, String metricName)
      Returns a Metric based on its metric name and metric designer
      Parameters:
      metricDesigner -
      metricName -
      Returns:
    • getMetric

      Metric getMetric(long id)
      Returns a Metric based on its identifier
      Parameters:
      id -
      Returns:
    • getMetrics

      List<Metric> getMetrics(MetricQuery query)
      Returns a List of Metrics based on a given query
      Parameters:
      query -
      Returns:
    • getAnswer

      Answer getAnswer(long id)
      Returns an Answer based on its identifier
      Parameters:
      id -
      Returns:
    • getAnswers

      List<Answer> getAnswers(AnswerQuery query)
      Returns a List of Answers based on a given query
      Parameters:
      query -
      Returns:
    • addAnswer

      long addAnswer(AnswerItem answer)
      Add a new Answer on WikiRate and returns its identifier
      Parameters:
      answer -
      Returns:
      the identifier of the new Answer on WikiRate
    • updateAnswer

      void updateAnswer(AnswerItem answer)
      Updates an Answer
      Parameters:
      answer -
    • getRelationship

      Relationship getRelationship(String name)
      Returns a Relationship on WikiRate based on its name
      Parameters:
      name -
      Returns:
    • getRelationship

      Relationship getRelationship(long id)
      Returns a Relationship on WikiRate based on its identifier
      Parameters:
      id -
      Returns:
    • getRelationships

      List<Relationship> getRelationships(RelationshipQuery query)
      Returns a List of Relationship based on a given query
      Parameters:
      query -
      Returns:
    • addRelationship

      long addRelationship(RelationshipItem answer)
      Adds a new Relationship on WikiRate and returns its identifier
      Parameters:
      answer -
      Returns:
      identifier
    • updateRelationship

      void updateRelationship(RelationshipItem answer)
      Updates an existing Relationship
      Parameters:
      answer -
    • getDataset

      Dataset getDataset(String name)
      Returns a Dataset based on its name
      Parameters:
      name -
      Returns:
    • getDataset

      Dataset getDataset(long id)
      Returns a Dataset based on its identifier
      Parameters:
      id -
      Returns:
    • getDatasets

      List<Dataset> getDatasets(DatasetQuery query)
      Retruns a List of Datasets based on a given query
      Parameters:
      query -
      Returns:
    • getTopic

      Topic getTopic(long id)
      Returns a Topic based on its identifier
      Parameters:
      id -
      Returns:
    • getTopic

      Topic getTopic(String name)
      Returns a Topic based on its name
      Parameters:
      name -
      Returns:
    • getTopics

      List<Topic> getTopics(TopicQuery query)
      Returns a List of Topics based on a given query
      Parameters:
      query -
      Returns:
    • getSource

      Source getSource(String name)
      Returns a Source based on its name
      Parameters:
      name -
      Returns:
    • getSource

      Source getSource(long id)
      Returns a Source based on its identifier
      Parameters:
      id -
      Returns:
    • addSource

      String addSource(Source source)
      Adds a new Source on WikiRate platform and returns its name
      Parameters:
      source -
      Returns:
      the source name of the new created Source on WikiRate platform
    • updateSource

      void updateSource(Source source)
      Updates an existing source
      Parameters:
      source -
    • getSources

      List<Source> getSources(SourceQuery query)
      Returns a List of Sources based on a given query
      Parameters:
      query -
      Returns:
    • getCompanyGroup

      CompanyGroup getCompanyGroup(String name)
      Returns a CompanyGroup based on its name
      Parameters:
      name -
      Returns:
    • getCompanyGroup

      CompanyGroup getCompanyGroup(long id)
      Returns a CompanyGroup based on its identifier
      Parameters:
      id -
      Returns:
    • getCompanyGroups

      List<CompanyGroup> getCompanyGroups(CompanyGroupQuery query)
      Returns a List of Company Groups based on a given query
      Parameters:
      query -
      Returns:
    • addCompanyGroup

      long addCompanyGroup(CompanyGroup companyGroup)
      Adds a new CompanyGroup on WikiRate platform and returns its identifier
      Parameters:
      companyGroup -
      Returns:
      the identifier of the new Company Group
    • updateCompanyGroup

      void updateCompanyGroup(CompanyGroup companyGroup)
      Updates an existing CompanyGroup
      Parameters:
      companyGroup -
    • getResearchGroup

      ResearchGroup getResearchGroup(String name)
      Returns a ResearchGroup based on its name
      Parameters:
      name -
      Returns:
    • getResearchGroup

      ResearchGroup getResearchGroup(long id)
      Returns a ResearchGroup based on its identifier
      Parameters:
      id -
      Returns:
    • getResearchGroups

      List<ResearchGroup> getResearchGroups(ResearchGroupQuery query)
      Returns a list of Research Groups based on a given query
      Parameters:
      query -
      Returns:
    • getRegion

      Region getRegion(String name)
      Returns a Region based on its name
      Parameters:
      name -
      Returns:
    • getRegion

      Region getRegion(long id)
      Returns a Region based on its identifier
      Parameters:
      id -
      Returns:
    • getRegions

      List<Region> getRegions(Query query)
      Returns a list of Regions based on a given query
      Parameters:
      query -
      Returns:
    • getChecksOfAnswer

      CheckedBy getChecksOfAnswer(String name)
      Returns a CheckedBy based its name
      Parameters:
      name -
      Returns:
    • getChecksOfAnswer

      CheckedBy getChecksOfAnswer(long id)
      Returns a CheckedBy based on its identifier
      Parameters:
      id -
      Returns:
    • getProjects

      List<Card> getProjects(ProjectQuery query)
      Returns a Card of Project type based on a given Project Query
      Parameters:
      query -
      Returns:
    • getCard

      Card getCard(long id)
      Returns a Card based on its identifier
      Parameters:
      id -
      Returns:
    • getCard

      Card getCard(String name)
      Returns a Card based on its name
      Parameters:
      name -
      Returns: