dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #00675
[Branch ~dhis2-devs-core/dhis2/trunk] Rev 186: Added Javadoc
------------------------------------------------------------
revno: 186
committer: Lars Helge Oeverland larshelge@xxxxxxxxx
branch nick: trunk
timestamp: Thu 2009-04-16 20:58:36 +0200
message:
Added Javadoc
modified:
dhis-2/dhis-api/src/main/java/org/hisp/dhis/pivottable/PivotTableService.java
dhis-2/dhis-api/src/main/java/org/hisp/dhis/report/ReportStore.java
dhis-2/dhis-api/src/main/java/org/hisp/dhis/reporttable/ReportTableService.java
dhis-2/dhis-api/src/main/java/org/hisp/dhis/reporttable/ReportTableStore.java
dhis-2/dhis-api/src/main/java/org/hisp/dhis/resourcetable/ResourceTableStore.java
dhis-2/dhis-api/src/main/java/org/hisp/dhis/source/SourceStore.java
dhis-2/dhis-api/src/main/java/org/hisp/dhis/user/UserStore.java
=== modified file 'dhis-2/dhis-api/src/main/java/org/hisp/dhis/pivottable/PivotTableService.java'
--- dhis-2/dhis-api/src/main/java/org/hisp/dhis/pivottable/PivotTableService.java 2009-03-03 16:46:36 +0000
+++ dhis-2/dhis-api/src/main/java/org/hisp/dhis/pivottable/PivotTableService.java 2009-04-16 18:58:36 +0000
@@ -34,5 +34,15 @@
*/
public interface PivotTableService
{
+ /**
+ * Returns a PivotTable object.
+ *
+ * @param indicatorGroupId the identifier of the IndicatorGroup.
+ * @param periodTypeName the identifier of the PeriodType.
+ * @param startDate the start date string.
+ * @param endDate the end date string.
+ * @param level the OrganisationUnit level.
+ * @return a PivotTable object.
+ */
PivotTable getPivotTable( int indicatorGroupId, String periodTypeName, String startDate, String endDate, int level );
}
=== modified file 'dhis-2/dhis-api/src/main/java/org/hisp/dhis/report/ReportStore.java'
--- dhis-2/dhis-api/src/main/java/org/hisp/dhis/report/ReportStore.java 2009-03-03 16:46:36 +0000
+++ dhis-2/dhis-api/src/main/java/org/hisp/dhis/report/ReportStore.java 2009-04-16 18:58:36 +0000
@@ -38,11 +38,33 @@
{
String ID = ReportStore.class.getName();
+ /**
+ * Saves a Report.
+ *
+ * @param report the Report to save.
+ * @return the generated identifier.
+ */
int saveReport( Report report );
+ /**
+ * Retrieves the Report with the given identifier.
+ *
+ * @param id the identifier of the Report to retrieve.
+ * @return the Report.
+ */
Report getReport( int id );
+ /**
+ * Deletes a Report.
+ *
+ * @param report the Report to delete.
+ */
void deleteReport( Report report );
+ /**
+ * Retrieves all Reports.
+ *
+ * @return a Collection of Reports.
+ */
Collection<Report> getAllReports();
}
=== modified file 'dhis-2/dhis-api/src/main/java/org/hisp/dhis/reporttable/ReportTableService.java'
--- dhis-2/dhis-api/src/main/java/org/hisp/dhis/reporttable/ReportTableService.java 2009-03-24 10:31:31 +0000
+++ dhis-2/dhis-api/src/main/java/org/hisp/dhis/reporttable/ReportTableService.java 2009-04-16 18:58:36 +0000
@@ -41,23 +41,85 @@
{
String ID = ReportTableService.class.getName();
+ /**
+ * Retrieves a List of Periods of the RelativePeriodType.
+ *
+ * @param relatives the RelativePeriods.
+ * @param months the number of months back in time which will be used as
+ * basis for the generation of relative Periods.
+ *
+ * @return a Collection of Periods of the RelativePeriodType.
+ */
List<Period> getRelativePeriods( RelativePeriods relatives, int months );
+ /**
+ * Returns the current date subtracted with the given number of months.
+ *
+ * @param months the numner of months.
+ * @return a Date.
+ */
Date getDateFromPreviousMonth( int months );
+ /**
+ * Saves a ReportTable.
+ *
+ * @param reportTable the ReportTable to save.
+ * @return the generated identifier.
+ */
int saveReportTable( ReportTable reportTable );
+ /**
+ * Updates a ReportTable.
+ *
+ * @param reportTable the ReportTable to update.
+ */
void updateReportTable( ReportTable reportTable );
+ /**
+ * Deletes a ReportTable.
+ *
+ * @param reportTable the ReportTable to delete.
+ */
void deleteReportTable( ReportTable reportTable );
+ /**
+ * Retrieves the ReportTable with the given identifier.
+ *
+ * @param id the identifier of the ReportTable to retrieve.
+ * @return the ReportTable.
+ */
ReportTable getReportTable( int id );
+ /**
+ * Retrieves a Collection of all ReportTables.
+ *
+ * @return a Collection of ReportTables.
+ */
Collection<ReportTable> getAllReportTables();
+ /**
+ * Retrieves ReportTables with the given identifiers.
+ *
+ * @param reportTables the identfiers of the ReportTables to retrieve.
+ * @return a Collection of ReportTables.
+ */
Collection<ReportTable> getReportTables( Collection<Integer> reportTables );
+ /**
+ * Retrieves the ReportTable with the given name.
+ *
+ * @param name the name of the ReportTable.
+ * @return the ReportTable.
+ */
ReportTable getReportTableByName( String name );
+ /**
+ * Retrieves a ReportTableData object for the ReportTable with the given
+ * identifier.
+ *
+ * @param id the identifier of the ReportTable which the ReportTableData is
+ * based on.
+ * @return a ReportTableData object.
+ */
ReportTableData getReportTableData( int id );
}
=== modified file 'dhis-2/dhis-api/src/main/java/org/hisp/dhis/reporttable/ReportTableStore.java'
--- dhis-2/dhis-api/src/main/java/org/hisp/dhis/reporttable/ReportTableStore.java 2009-03-24 10:31:31 +0000
+++ dhis-2/dhis-api/src/main/java/org/hisp/dhis/reporttable/ReportTableStore.java 2009-04-16 18:58:36 +0000
@@ -36,16 +36,49 @@
public interface ReportTableStore
{
String ID = ReportTableStore.class.getName();
-
+
+ /**
+ * Saves a ReportTable.
+ *
+ * @param reportTable the ReportTable to save.
+ * @return the generated identifier.
+ */
int saveReportTable( ReportTable reportTable );
-
+
+ /**
+ * Updates a ReportTable.
+ *
+ * @param reportTable the ReportTable to update.
+ */
void updateReportTable( ReportTable reportTable );
-
+
+ /**
+ * Deletes a ReportTable.
+ *
+ * @param reportTable the ReportTable to delete.
+ */
void deleteReportTable( ReportTable reportTable );
-
+
+ /**
+ * Retrieves the ReportTable with the given identifier.
+ *
+ * @param id the identifier of the ReportTable to retrieve.
+ * @return the ReportTable.
+ */
ReportTable getReportTable( int id );
-
+
+ /**
+ * Retrieves a Collection of all ReportTables.
+ *
+ * @return a Collection of ReportTables.
+ */
Collection<ReportTable> getAllReportTables();
-
+
+ /**
+ * Retrieves the ReportTable with the given name.
+ *
+ * @param name the name of the ReportTable.
+ * @return the ReportTable.
+ */
ReportTable getReportTableByName( String name );
}
=== modified file 'dhis-2/dhis-api/src/main/java/org/hisp/dhis/resourcetable/ResourceTableStore.java'
--- dhis-2/dhis-api/src/main/java/org/hisp/dhis/resourcetable/ResourceTableStore.java 2009-03-03 16:46:36 +0000
+++ dhis-2/dhis-api/src/main/java/org/hisp/dhis/resourcetable/ResourceTableStore.java 2009-04-16 18:58:36 +0000
@@ -10,29 +10,77 @@
// OrganisationUnitStructure
// -------------------------------------------------------------------------
+ /**
+ * Adds an OrganisationUnitStructure.
+ *
+ * @param structure the OrganisationUnitStructure to add.
+ * @return the generated identifier.
+ */
int addOrganisationUnitStructure( OrganisationUnitStructure structure );
+ /**
+ * Retrieves all OrganisationUnitStructures.
+ *
+ * @return a Collection of OrganisationUnitStructures.
+ */
Collection<OrganisationUnitStructure> getOrganisationUnitStructures();
+ /**
+ * Deletes all OrganisationUnitStructures.
+ *
+ * @return the number of deleted objects.
+ */
int deleteOrganisationUnitStructures();
// -------------------------------------------------------------------------
// GroupSetStructure
// -------------------------------------------------------------------------
+ /**
+ * Adds a GroupSetStructure.
+ *
+ * @param structure the GroupSetStructure to add.
+ * @return the generated identifier.
+ */
int addGroupSetStructure( GroupSetStructure structure );
+ /**
+ * Retrieves all GroupSetStructures.
+ *
+ * @return a Collection of GroupSetStructures.
+ */
Collection<GroupSetStructure> getGroupSetStructures();
+ /**
+ * Deletes all GroupSetStructures.
+ *
+ * @return the number of deleted objects.
+ */
int deleteGroupSetStructures();
// -------------------------------------------------------------------------
// DataElementCategoryOptionComboName
// -------------------------------------------------------------------------
+ /**
+ * Adds a DataElementCategoryOptionComboName.
+ *
+ * @param name the DataElementCategoryOptionComboName to add.
+ * @return the generated identifier.
+ */
int addDataElementCategoryOptionComboName( DataElementCategoryOptionComboName name );
+ /**
+ * Retrieves all DataElementCategoryOptionComboNames.
+ *
+ * @return a Collection of DataElementCategoryOptionComboNames.
+ */
Collection<DataElementCategoryOptionComboName> getDataElementCategoryOptionComboNames();
+ /**
+ * Deletes all DataElementCategoryOptionComboNames.
+ *
+ * @return the number of deleted objects.
+ */
int deleteDataElementCategoryOptionComboNames();
}
=== modified file 'dhis-2/dhis-api/src/main/java/org/hisp/dhis/source/SourceStore.java'
--- dhis-2/dhis-api/src/main/java/org/hisp/dhis/source/SourceStore.java 2009-03-03 16:46:36 +0000
+++ dhis-2/dhis-api/src/main/java/org/hisp/dhis/source/SourceStore.java 2009-04-16 18:58:36 +0000
@@ -37,15 +37,48 @@
{
String ID = SourceStore.class.getName();
+ /**
+ * Adds a Source.
+ *
+ * @param source the Source to add.
+ * @return the generated identifier.
+ */
<S extends Source> int addSource( S source );
+ /**
+ * Updated a Source.
+ *
+ * @param source the Source to update.
+ */
<S extends Source> void updateSource( S source );
+ /**
+ * Deletes a Source.
+ *
+ * @param source the Source to delete.
+ */
<S extends Source> void deleteSource( S source );
+ /**
+ * Retrieves the Source with the given identifier.
+ *
+ * @param id the identifier of the Source to retrieve.
+ * @return the Source.
+ */
<S extends Source> S getSource( int id );
+ /**
+ * Retrieves all Sources of the given Class.
+ *
+ * @param clazz the Class of the Sources to retrieve.
+ * @return a Collection of Sources.
+ */
<S extends Source> Collection<S> getAllSources( Class<S> clazz );
+ /**
+ * Retrieves all Sources.
+ *
+ * @return a Collection of Sources.
+ */
<S extends Source> Collection<S> getAllSources();
}
=== modified file 'dhis-2/dhis-api/src/main/java/org/hisp/dhis/user/UserStore.java'
--- dhis-2/dhis-api/src/main/java/org/hisp/dhis/user/UserStore.java 2009-03-03 16:46:36 +0000
+++ dhis-2/dhis-api/src/main/java/org/hisp/dhis/user/UserStore.java 2009-04-16 18:58:36 +0000
@@ -43,63 +43,196 @@
// User
// -------------------------------------------------------------------------
+ /**
+ * Adds a User.
+ *
+ * @param user the User to add.
+ * @return the generated identifier.
+ */
int addUser( User user );
+ /**
+ * Updates a User.
+ *
+ * @param user the User to update.
+ */
void updateUser( User user );
+ /**
+ * Retrieves the User with the given identifier.
+ *
+ * @param idn the identifier of the User to retrieve.
+ * @return the User.
+ */
User getUser( int id );
+ /**
+ * Returns a Collection of all Users.
+ *
+ * @return a Collection of Users.
+ */
Collection<User> getAllUsers();
+ /**
+ * Returns a Collection of the Users associated with the given OrganisationUnit.
+ *
+ * @param organisationUnit the OrganisationUnit.
+ * @return a Collection of Users.
+ */
Collection<User> getUsersByOrganisationUnit( OrganisationUnit organisationUnit );
+ /**
+ * Returns a Collection of the Users which are not associated with any OrganisationUnits.
+ *
+ * @return a Collection of Users.
+ */
Collection<User> getUsersWithoutOrganisationUnit();
+ /**
+ * Deletes a User.
+ *
+ * @param user the User to delete.
+ */
void deleteUser( User user );
// -------------------------------------------------------------------------
// UserCredentials
// -------------------------------------------------------------------------
+ /**
+ * Adds a UserCredentials.
+ *
+ * @param userCredentials the UserCredentials to add.
+ * @return the User which the UserCredentials is associated with.
+ */
User addUserCredentials( UserCredentials userCredentials );
+ /**
+ * Updates a UserCredentials.
+ *
+ * @param userCredentials the UserCredentials to update.
+ */
void updateUserCredentials( UserCredentials userCredentials );
+ /**
+ * Retrieves the UserCredentials of the given User.
+ *
+ * @param user the User.
+ * @return the UserCredentials.
+ */
UserCredentials getUserCredentials( User user );
+ /**
+ * Retrieves the UserCredentials associated with the User with the given name.
+ *
+ * @param username the name of the User.
+ * @return the UserCredentials.
+ */
UserCredentials getUserCredentialsByUsername( String username );
+ /**
+ * Retrieves all UserCredentials.
+ *
+ * @return a Collection of UserCredentials.
+ */
Collection<UserCredentials> getAllUserCredentials();
+ /**
+ * Deletes a UserCredentials.
+ *
+ * @param userCredentials the UserCredentials.
+ */
void deleteUserCredentials( UserCredentials userCredentials );
// -------------------------------------------------------------------------
// UserAuthorityGroup
// -------------------------------------------------------------------------
+ /**
+ * Adds a UserAuthorityGroup.
+ *
+ * @param userAuthorityGroup the UserAuthorityGroup.
+ * @return the generated identifier.
+ */
int addUserAuthorityGroup( UserAuthorityGroup userAuthorityGroup );
+ /**
+ * Updates a UserAuthorityGroup.
+ *
+ * @param userAuthorityGroup the UserAuthorityGroup.
+ */
void updateUserAuthorityGroup( UserAuthorityGroup userAuthorityGroup );
+ /**
+ * Retrieves the UserAuthorityGroup with the given identifier.
+ *
+ * @param id the identifier of the UserAuthorityGroup to retrieve.
+ * @return the UserAuthorityGroup.
+ */
UserAuthorityGroup getUserAuthorityGroup( int id );
+ /**
+ * Retrieves the UserAuthorityGroup with the given name.
+ *
+ * @param name the name of the UserAuthorityGroup to retrieve.
+ * @return the UserAuthorityGroup.
+ */
UserAuthorityGroup getUserAuthorityGroupByName( String name );
+ /**
+ * Retrieves all UserAuthorityGroups.
+ *
+ * @return a Collectio of UserAuthorityGroups.
+ */
Collection<UserAuthorityGroup> getAllUserAuthorityGroups();
+ /**
+ * Deletes a UserAuthorityGroup.
+ *
+ * @param userAuthorityGroup the UserAuthorityGroup to delete.
+ */
void deleteUserAuthorityGroup( UserAuthorityGroup userAuthorityGroup );
// -------------------------------------------------------------------------
// UserSettings
// -------------------------------------------------------------------------
+ /**
+ * Adds a UserSetting.
+ *
+ * @param userSetting the UserSetting to add.
+ */
void addUserSetting( UserSetting userSetting );
+ /**
+ * Updates a UserSetting.
+ *
+ * @param userSetting the UserSetting to update.
+ */
void updateUserSetting( UserSetting userSetting );
+ /**
+ * Retrieves the UserSetting associated with the given User for the given
+ * UserSetting name.
+ *
+ * @param user the User.
+ * @param name the name of the UserSetting.
+ * @return the UserSetting.
+ */
UserSetting getUserSetting( User user, String name );
+ /**
+ * Retrieves all UserSettings for the given User.
+ *
+ * @param user the User.
+ * @return a Collection of UserSettings.
+ */
Collection<UserSetting> getAllUserSettings( User user );
+ /**
+ * Deletes a UserSetting.
+ *
+ * @param userSetting the UserSetting to delete.
+ */
void deleteUserSetting( UserSetting userSetting );
}
--
Trunk
https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk
Your team DHIS 2 developers is subscribed to branch lp:dhis2.
To unsubscribe from this branch go to https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk/+edit-subscription.
